org.apache.jetspeed.om.page

Interface BaseFragmentsElement

All Superinterfaces:

BaseElement, Document, Node, SecuredResource

All Known Subinterfaces:

BaseConcretePageElement, BasePageElement, Dashboard, DynamicPage, FragmentDefinition, Page, PageTemplate

public interface BaseFragmentsElement
extends Document

This interface represents a generic document with fragments.

Version:

$Id:$

Author:

Randy Watler

Field Summary

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

PATH_SEPARATOR, PATH_SEPARATOR_CHAR

Method Summary

Methods

Modifier and Type	Method and Description
BaseFragmentElement	getFragmentById(String id) Retrieves the fragment contained within this page, with the specified Id.
List<BaseFragmentElement>	getFragmentsByInterface(Class interfaceFilter) Retrieves the fragments contained within this page, with the specified interface.
List<BaseFragmentElement>	getFragmentsByName(String name) Retrieves the fragments contained within this page, with the specified name.
BaseFragmentElement	getRootFragment() Retrieves the top level fragment of this page.
BaseFragmentElement	removeFragmentById(String id) Removes the fragment contained within this page, with the specified Id.
void	setRootFragment(BaseFragmentElement fragment) Sets the top level fragment of this page.

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, isStale, setShortTitle, setTitle

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

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

Method Detail

getRootFragment

BaseFragmentElement getRootFragment()

Retrieves the top level fragment of this page. This Fragment should never be null.

Returns:

the base Fragment object for this page.

setRootFragment

void setRootFragment(BaseFragmentElement fragment)

Sets the top level fragment of this page. This Fragment should never be null.

getFragmentById

BaseFragmentElement getFragmentById(String id)

Retrieves the fragment contained within this page, with the specified Id.

Parameters:

id - the fragment id to look for

Returns:

the found Fragment object or null if not found

removeFragmentById

BaseFragmentElement removeFragmentById(String id)

Removes the fragment contained within this page, with the specified Id.

Parameters:

id - the fragment id to remove

Returns:

the removed Fragment object or null if not found

getFragmentsByName

List<BaseFragmentElement> getFragmentsByName(String name)

Retrieves the fragments contained within this page, with the specified name.

Parameters:

name - the fragment name to look for

Returns:

the list of found Fragment objects or null if not found

getFragmentsByInterface

List<BaseFragmentElement> getFragmentsByInterface(Class interfaceFilter)

Retrieves the fragments contained within this page, with the specified interface.

Parameters:

interfaceFilter - the fragment interface to match or null for all

Returns:

the list of found Fragment objects or null if not found