org.apache.jetspeed.om.page
Interface ContentPage

All Superinterfaces:
BaseElement, Cloneable, 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
 
Fields inherited from interface org.apache.jetspeed.om.common.SecuredResource
EDIT_ACTION, VIEW_ACTION
 
Method Summary
 ContentFragment getContentFragmentById(String id)
          Returns a ContentFragment that wraps the actual Fragment metadata represented by the id argument.
 Fragment getFragmentById(String id)
          Overridden to to indicate that the Fragment returned must also be an instance 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.
 
Methods inherited from interface org.apache.jetspeed.om.page.Page
clone, getDefaultDecorator, getDefaults, getDefaultSkin, getMenuDefinitions, setDefaultDecorator, setDefaultSkin, setMenuDefinitions, setRootFragment
 
Methods inherited from interface org.apache.jetspeed.page.document.Node
getMetadata, getName, getParent, getPath, getShortTitle, getTitle, getType, getUrl, isHidden, setParent, setPath
 
Methods inherited from interface org.apache.jetspeed.om.page.BaseElement
getId, getShortTitle, getTitle, setId, setShortTitle, setTitle
 
Methods inherited from interface org.apache.jetspeed.om.common.SecuredResource
checkAccess, checkConstraints, checkPermissions, getConstraintsEnabled, getPermissionsEnabled, getSecurityConstraints, setSecurityConstraints
 

Method Detail

getRootContentFragment

public 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.

getContentFragmentById

public 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:

getFragmentById

public 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

getRootFragment

public 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.


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.