org.apache.jetspeed.om.page

Interface ContentPage

public interface ContentPage

ContentPage is a read-only version of the Page object for use in rendering. Page objects are persistent, single-instance metadata objects that should not be used to hold per-request content. ContentPage solves this by providing a parallel interface that can be used for rendering requested content associated with the current user-request.

Author:

weaver@apache.org

Method Summary

Methods

Modifier and Type	Method and Description
ContentFragment	addFragmentAtRowColumn(ContentFragment fragment, int row, int column) Add fragment to page at specified row column layout position.
ContentFragment	addFragmentReference(String id) Add fragment reference to page returning associated content fragment.
ContentFragment	addPortlet(String type, String name) Add portlet to page returning associated content fragment.
void	checkAccess(String actions) Check security access to page.
void	decrementFolderInDocumentOrder() Decrement position of folder in parent folder document order.
void	decrementInDocumentOrder() Decrement position of page in folder document order.
String	getContentType() Get the content type name that applies to this page.
String	getDefaultDecorator(String fragmentType) Returns the name of the default decorator that applies in this page to fragments of the specified type
String	getDefId() Returns the id of the defined root fragment element.
String	getEffectiveDefaultDecorator(String fragmentType) Returns the name of the default decorator as set here or in parent folders that applies in this page to fragments of the specified type.
ContentFragment	getFragmentByFragmentId(String id) Returns a ContentFragment represented by the underlying PSML Fragment fragment.
ContentFragment	getFragmentByFragmentId(String id, boolean nonTemplate) Returns a ContentFragment represented by the underlying PSML Fragment fragment.
ContentFragment	getFragmentById(String id) Returns a ContentFragment represented by the fragment id argument.
Map<String,FragmentDefinition>	getFragmentDefinitions() Access underlying concrete persistent fragment definitions map or null if page is transient or constructed dynamically.
int	getFragmentNestingLevel(String fragmentId) Compute fragment nesting level of fragment by id.
List<ContentFragment>	getFragmentsByName(String name) Returns a list of ContentFragment fragments represented by the name argument.
List<ContentFragment>	getFragmentsByName(String name, boolean nonTemplate) Returns a list of ContentFragment fragments represented by the name argument.
String	getId() Returns the unique Id of this element.
GenericMetadata	getMetadata() Return page metadata.
String	getName() Returns the name of this page.
ContentFragment	getNonTemplateRootFragment() Returns the root layout fragment which is not merged from a page template.
PageLayoutComponent	getPageLayoutComponent() Returns the PageLayoutComponent that generated this ContentPage
BaseFragmentsElement	getPageOrTemplate() Access underlying concrete persistent page, template, or null if page is transient or constructed dynamically.
PageTemplate	getPageTemplate() Access underlying concrete persistent page template or null if page is transient or constructed dynamically.
String	getPath() Returns the path of this page.
ContentFragment	getRootFragment() Provides access to a per-request safe ContentFragment.
String	getShortTitle() Returns the short title in the default Locale
String	getShortTitle(Locale locale) Returns the short title for the specified locale.
String	getSkin() Returns the name of the default skin that applies to this page.
String	getTitle() Returns the title in the default Locale
String	getTitle(Locale locale) Returns the title for the specified locale.
String	getUrl() Returns URL of page.
void	incrementFolderInDocumentOrder() Increment position of folder in parent folder document order.
void	incrementInDocumentOrder() Increment position of page in folder document order.
boolean	isHidden() Whether or not this Node should be hidden in terms of the view.
boolean	isInheritable() Get inheritable flag that indicates whether this dynamic page can be inherited for child content pages.
void	moveFragment(String fragmentId, String fromFragmentId, String toFragmentId) Move fragment from current parent layout fragment to another layout fragment in the same page.
void	newSiblingDynamicPage(String pageName, String contentType, String layoutName, String pageTitle, String pageShortTitle) Create new sibling dynamic page with specified configuration.
void	newSiblingFolder(String folderName, String folderTitle, String folderShortTitle, String defaultPageLayoutName) Create a new sibling folder with specified configuration and new default page.
void	newSiblingFragmentDefinition(String definitionName, String defId, String portletName, String definitionTitle, String definitionShortTitle) Create new sibling fragment definition with specified configuration.
void	newSiblingPage(String pageName, String layoutName, String pageTitle, String pageShortTitle) Create new sibling page with specified configuration and add new page at end of folder document order list.
void	newSiblingPageTemplate(String templateName, String layoutName, String templateTitle, String templateShortTitle) Create new sibling page template with specified configuration.
void	overrideDefaultDecorator(String decoratorName, String fragmentType) Override page default decorator.
void	remove() Remove page and remove from folder document order list.
void	removeFolder() Remove folder and remove from parent folder document order list.
void	removeFragment(String fragmentId) Remove fragment from page by id.
void	updateContent(String contentType, Boolean inheritable) Update dynamic page content type and inheritable flag.
void	updateDefaultDecorator(String decoratorName, String fragmentType) Update page default decorator.
void	updateFolderTitles(String title, String shortTitle) Update folder titles.
void	updateTitles(String title, String shortTitle) Update page titles.

Method Detail

checkAccess

void checkAccess(String actions)
                 throws SecurityException

Check security access to page.

Parameters:

actions - list to be checked against in CSV string form

Throws:

SecurityException

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

getShortTitle

String getShortTitle()

Returns the short title in the default Locale

Returns:

the page short title

getMetadata

GenericMetadata getMetadata()

Return page metadata.

Returns:

page metadata

getName

String getName()

Returns the name of this page.

Returns:

page name

getPath

String getPath()

Returns the path of this page.

Returns:

page path

getShortTitle

String getShortTitle(Locale locale)

Returns the short title for the specified locale.

Parameters:

locale -

Returns:

localized title of this Node.

getTitle

String getTitle(Locale locale)

Returns the title for the specified locale.

Parameters:

locale -

Returns:

localized title of this Node.

getUrl

String getUrl()

Returns URL of page.

Returns:

page URL

isHidden

boolean isHidden()

Whether or not this Node should be hidden in terms of the view.

Returns:

hidden flag

getSkin

String getSkin()

Returns the name of the default skin that applies to this page.

Returns:

the page default skin name

getDefaultDecorator

String getDefaultDecorator(String fragmentType)

Returns the name of the default decorator that applies in this page to fragments of the specified type

Parameters:

fragmentType - the type of fragment considered

Returns:

the decorator name for the selected type

getRootFragment

ContentFragment getRootFragment()

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.

Returns:

root ContentFragment fragment.

getFragmentById

ContentFragment getFragmentById(String id)

Returns a ContentFragment represented by the fragment id argument.

Parameters:

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

Returns:

getFragmentByFragmentId

ContentFragment getFragmentByFragmentId(String id)

Returns a ContentFragment represented by the underlying PSML Fragment fragment.

Parameters:

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

Returns:

getFragmentsByName

List<ContentFragment> getFragmentsByName(String name)

Returns a list of ContentFragment fragments represented by the name argument.

Parameters:

name - name of the ContentFragments we want to retrieve.

Returns:

list of ContentFragment

getEffectiveDefaultDecorator

String getEffectiveDefaultDecorator(String fragmentType)

Returns the name of the default decorator as set here or in parent folders that applies in this page to fragments of the specified type.

Parameters:

fragmentType - the type of fragment considered

Returns:

the decorator name for the selected type

getContentType

String getContentType()

Get the content type name that applies to this page.

Returns:

the page type name

isInheritable

boolean isInheritable()

Get inheritable flag that indicates whether this dynamic page can be inherited for child content pages.

Returns:

inheritable flag

getDefId

String getDefId()

Returns the id of the defined root fragment element.

Returns:

the defined root fragment id

getPageOrTemplate

BaseFragmentsElement getPageOrTemplate()

Access underlying concrete persistent page, template, or null if page is transient or constructed dynamically.

Returns:

persistent page or null

getPageTemplate

PageTemplate getPageTemplate()

Access underlying concrete persistent page template or null if page is transient or constructed dynamically.

Returns:

persistent page template or null

getFragmentDefinitions

Map<String,FragmentDefinition> getFragmentDefinitions()

Access underlying concrete persistent fragment definitions map or null if page is transient or constructed dynamically.

Returns:

persistent fragment definitions or null

getPageLayoutComponent

PageLayoutComponent getPageLayoutComponent()

Returns the PageLayoutComponent that generated this ContentPage

Returns:

PageLayoutComponent instance.

overrideDefaultDecorator

void overrideDefaultDecorator(String decoratorName,
                            String fragmentType)

Override page default decorator.

Parameters:

decoratorName - decorator name

fragmentType - decorator fragment type

getFragmentByFragmentId

ContentFragment getFragmentByFragmentId(String id,
                                      boolean nonTemplate)

Returns a ContentFragment represented by the underlying PSML Fragment fragment.

Parameters:

id - unique id of the content fragment we want to retrieve.

nonTemplate - return only non-template matching fragments

Returns:

first matching content fragment

getFragmentsByName

List<ContentFragment> getFragmentsByName(String name,
                                       boolean nonTemplate)

Returns a list of ContentFragment fragments represented by the name argument.

Parameters:

name - name of the content fragments we want to retrieve.

nonTemplate - return only non-template matching fragments

Returns:

list of matching content fragments

getNonTemplateRootFragment

ContentFragment getNonTemplateRootFragment()

Returns the root layout fragment which is not merged from a page template.

Returns:

root non-template layout content fragment

addFragmentAtRowColumn

ContentFragment addFragmentAtRowColumn(ContentFragment fragment,
                                     int row,
                                     int column)

Add fragment to page at specified row column layout position.

Parameters:

fragment - externally constructed fragment to add

row - fragment row position

column - fragment column position

addFragmentReference

ContentFragment addFragmentReference(String id)

Add fragment reference to page returning associated content fragment.

Parameters:

id - fragment definition id

Returns:

new content fragment added to page

addPortlet

ContentFragment addPortlet(String type,
                         String name)

Add portlet to page returning associated content fragment.

Parameters:

type - portlet type

name - portlet name

Returns:

new content fragment added to page

decrementFolderInDocumentOrder

void decrementFolderInDocumentOrder()

Decrement position of folder in parent folder document order.

decrementInDocumentOrder

void decrementInDocumentOrder()

Decrement position of page in folder document order.

getFragmentNestingLevel

int getFragmentNestingLevel(String fragmentId)

Compute fragment nesting level of fragment by id. Fragment level returned is 0 if root fragment, 1 if in root fragment collection, etc.

Parameters:

fragmentId - target fragment id

Returns:

fragment nesting level or -1 if not found

incrementFolderInDocumentOrder

void incrementFolderInDocumentOrder()

Increment position of folder in parent folder document order.

incrementInDocumentOrder

void incrementInDocumentOrder()

Increment position of page in folder document order.

moveFragment

void moveFragment(String fragmentId,
                String fromFragmentId,
                String toFragmentId)

Move fragment from current parent layout fragment to another layout fragment in the same page.

Parameters:

fragmentId - fragment id of fragment to move

fromFragmentId - fragment id of current parent layout fragment

toFragmentId - fragment id of new parent layout fragment

newSiblingFolder

void newSiblingFolder(String folderName,
                    String folderTitle,
                    String folderShortTitle,
                    String defaultPageLayoutName)

Create a new sibling folder with specified configuration and new default page. Also, adds folder to end of page folder document order list. The default page is added to the new folder document order list. Both title and short title parameters default to page name if not specified. The layout fragment name for the default page is cloned from this content page if not specified. Default decorators are cloned from this content page.

Parameters:

folderName - unique new folder name, (also used as default page title)

folderTitle - new folder title or null

folderShortTitle - new folder short title or null

defaultPageLayoutName - root level layout fragment name for default page

newSiblingPage

void newSiblingPage(String pageName,
                  String layoutName,
                  String pageTitle,
                  String pageShortTitle)

Create new sibling page with specified configuration and add new page at end of folder document order list. Both title and short title parameters default to page name if not specified. The layout fragment name is cloned from this content page if not specified. Default decorators are cloned from this content page.

Parameters:

pageName - unique new page name

layoutName - root level layout fragment name or null

pageTitle - new page title or null

pageShortTitle - new page short title or null

newSiblingDynamicPage

void newSiblingDynamicPage(String pageName,
                         String contentType,
                         String layoutName,
                         String pageTitle,
                         String pageShortTitle)

Create new sibling dynamic page with specified configuration. Both title and short title parameters default to page name if not specified. The layout fragment name is cloned from this content page if not specified. Default decorators are cloned from this content page.

Parameters:

pageName - unique new dynamic page name

contentType - dynamic page content type

layoutName - root level layout fragment name or null

pageTitle - new page title or null

pageShortTitle - new page short title or null

newSiblingPageTemplate

void newSiblingPageTemplate(String templateName,
                          String layoutName,
                          String templateTitle,
                          String templateShortTitle)

Create new sibling page template with specified configuration. The layout fragment name is cloned from this content page if not specified. Default decorators are cloned from this content page.

Parameters:

templateName - unique new page template name

layoutName - root level layout fragment name or null

templateTitle - new page title or null

templateShortTitle - new page short title or null

newSiblingFragmentDefinition

void newSiblingFragmentDefinition(String definitionName,
                                String defId,
                                String portletName,
                                String definitionTitle,
                                String definitionShortTitle)

Create new sibling fragment definition with specified configuration.

Parameters:

definitionName - unique new fragment definition name

defId - unique new fragment definition id or null

portletName - root level portlet fragment name or null

definitionTitle - new page title or null

definitionShortTitle - new page short title or null

removeFragment

void removeFragment(String fragmentId)

Remove fragment from page by id.

Parameters:

fragmentId - id of fragment to remove

remove

void remove()

Remove page and remove from folder document order list.

removeFolder

void removeFolder()

Remove folder and remove from parent folder document order list.

updateContent

void updateContent(String contentType,
                 Boolean inheritable)

Update dynamic page content type and inheritable flag.

Parameters:

contentType - dynamic page content type

contentType - dynamic page content type

updateDefaultDecorator

void updateDefaultDecorator(String decoratorName,
                          String fragmentType)

Update page default decorator.

Parameters:

decoratorName - decorator name

fragmentType - decorator fragment type

updateFolderTitles

void updateFolderTitles(String title,
                      String shortTitle)

Update folder titles.

Parameters:

title - folder title

shortTitle - folder short title

updateTitles

void updateTitles(String title,
                String shortTitle)

Update page titles.

Parameters:

title - page title

shortTitle - page short title