org.apache.jetspeed.om.page

Interface BaseElement

All Superinterfaces:

SecuredResource

All Known Subinterfaces:

BaseConcretePageElement, BaseFragmentElement, BaseFragmentsElement, BasePageElement, Dashboard, Document, DynamicPage, Folder, Fragment, FragmentDefinition, FragmentReference, Link, Node, Page, PageFragment, PageSecurity, PageTemplate

public interface BaseElement
extends SecuredResource

BaseElement

Version:

$Id: BaseElement.java 995680 2010-09-10 06:14:22Z rwatler $

Author:

David Sean Taylor

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Returns the unique Id of this element.
String	getShortTitle() Returns the short title in the default Locale
String	getTitle() Returns the title in the default Locale
boolean	isStale() Returns whether this object is stale and should be refreshed from the page manager.
void	setShortTitle(String title) Sets the short title for the default Locale
void	setTitle(String title) Sets the title for the default Locale

Methods inherited from interface org.apache.jetspeed.om.common.SecuredResource

checkAccess, checkConstraints, checkPermissions, getConstraintsEnabled, getPermissionsEnabled, getSecurityConstraints, newSecurityConstraint, newSecurityConstraints, setSecurityConstraints

Method Detail

getId

String getId()

Returns the unique Id of this element. This id is guaranteed to be unique from the complete portal and is suitable to be used as a unique key.

Returns:

the unique id of this element.

getTitle

String getTitle()

Returns the title in the default Locale

Returns:

the page title

setTitle

void setTitle(String title)

Sets the title for the default Locale

Parameters:

title - the new title

getShortTitle

String getShortTitle()

Returns the short title in the default Locale

Returns:

the page short title

setShortTitle

void setShortTitle(String title)

Sets the short title for the default Locale

Parameters:

title - the new title

isStale

boolean isStale()

Returns whether this object is stale and should be refreshed from the page manager. This flag need only be checked against page manager elements that are cached externally outside the scope of a single request, (e.g. cached in a session).

Returns:

stale status flag