org.apache.jetspeed.om.page
Interface ContentPage

All Superinterfaces:

BaseElement, Document, Node, Page, SecuredResource, Serializable

public interface ContentPage
extends Page

PageFragment is a volatile wrapper around a Page metadata object for use in rendering. As with the Fragment object, Page objects are persistent, single-instance metadata objects that should not be used to hold per-request content. ContentPage solves this by providing a thin, wrapper interface that can be used for rendering requested content associated with the wrapped page relative to the currect user-request.

Author:

weaver@apache.org

Field Summary

Fields inherited from interface org.apache.jetspeed.om.page.Page

DOCUMENT_TYPE

Fields inherited from interface org.apache.jetspeed.page.document.Node

PATH_SEPARATOR, PATH_SEPARATOR_CHAR

Method Summary

ContentFragment	getContentFragmentById(String id) Returns a ContentFragment that wraps the actual Fragment metadata represented by the id argument.
List	getContentFragmentsByName(String name) Returns a list of ContentFragment that wrap the actual Fragment metadata represented by the name argument.
Fragment	getFragmentById(String id) Overridden to to indicate that the Fragment returned must also be an instance of ContentFragment.
List	getFragmentsByName(String name) Overridden to to indicate that the list of Fragment instances returned must also be instances of ContentFragment.
ContentFragment	getRootContentFragment() Provides access to a per-request safe ContentFragment.
Fragment	getRootFragment() Overridden to to indicate that the Fragment returned must also be an instance of ContentFragment.
void	setRootContentFragment(ContentFragment frag)

Methods inherited from interface org.apache.jetspeed.om.page.Page

getDefaultDecorator, getEffectiveDefaultDecorator, getMenuDefinitions, getSkin, newMenuDefinition, newMenuExcludeDefinition, newMenuIncludeDefinition, newMenuOptionsDefinition, newMenuSeparatorDefinition, removeFragmentById, setDefaultDecorator, setMenuDefinitions, setRootFragment, setSkin

Methods inherited from interface org.apache.jetspeed.om.page.Document

getVersion, isDirty, setDirty, setVersion

Methods inherited from interface org.apache.jetspeed.page.document.Node

getMetadata, getName, getParent, getPath, getShortTitle, getTitle, getType, getUrl, isHidden, setHidden, setParent, setPath

Methods inherited from interface org.apache.jetspeed.om.page.BaseElement

getId, getShortTitle, getTitle, setShortTitle, setTitle

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

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

Method Detail

getRootContentFragment

ContentFragment getRootContentFragment()

Provides access to a per-request safe ContentFragment. ContentFragments add the additional ability to temporarily store rendered content of the current request along with original, persistent metadata of the Fragment itself.

Returns:

ContentFragment wrapping the actual root Fragment.

setRootContentFragment

void setRootContentFragment(ContentFragment frag)

getContentFragmentById

ContentFragment getContentFragmentById(String id)

Returns a ContentFragment that wraps the actual Fragment metadata represented by the id argument.

Parameters:

id - unique id of the Fragment we want to retrieve.

Returns:

getContentFragmentsByName

List getContentFragmentsByName(String name)

Returns a list of ContentFragment that wrap the actual Fragment metadata represented by the name argument.

Parameters:

name - name of the Fragments we want to retrieve.

Returns:

getFragmentById

Fragment getFragmentById(String id)

Overridden to to indicate that the Fragment returned must also be an instance of ContentFragment.

Specified by:

getFragmentById in interface Page

Parameters:

id - the fragment id to look for

Returns:

the found ContentFragment object or null if not found

getFragmentsByName

List getFragmentsByName(String name)

Overridden to to indicate that the list of Fragment instances returned must also be instances of ContentFragment.

Specified by:

getFragmentsByName in interface Page

Parameters:

name - the fragments name to look for

Returns:

the list of found ContentFragment object or null if not found

getRootFragment

Fragment getRootFragment()

Overridden to to indicate that the Fragment returned must also be an instance of ContentFragment.

Specified by:

getRootFragment in interface Page

Returns:

the base Fragment object for this page.