org.apache.jetspeed.om.page
Interface ContentFragment

All Superinterfaces:
BaseElement, Cloneable, Fragment, SecuredResource, Serializable

public interface ContentFragment
extends Fragment

ContentFragment provides a volatile wrapper interface for actual Fragment metadata objects. Since Fragments are cached and are not request specific they cannot be used to store request-level content. This is where we use the ContentFragment to solve this problem.

Author:
weaver@apache.org

Field Summary
 
Fields inherited from interface org.apache.jetspeed.om.page.Fragment
LAYOUT, PORTLET
 
Fields inherited from interface org.apache.jetspeed.om.common.SecuredResource
EDIT_ACTION, VIEW_ACTION
 
Method Summary
 List getContentFragments()
          Provides a list of of child ContentFragments that wrap the actual Fragment metadata objects.
 List getFragments()
          Overridden to make it clear to the implemetor the List returned MUST ContentFragments and not just regular Fragments
 String getRenderedContent()
           getRenderedContent
 void overrideRenderedContent(String contnent)
           overrideRenderedContent
 void setPortletContent(PortletContent portletContent)
           setPortletContent
 
Methods inherited from interface org.apache.jetspeed.om.page.Fragment
addProperty, clearProperties, clone, getDecorator, getLayoutProperties, getName, getProperties, getPropertyValue, getSkin, getState, getType, isReference, removeProperty, setDecorator, setName, setPropertyValue, setSkin, setState, setType
 
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

getContentFragments

public List getContentFragments()
Provides a list of of child ContentFragments that wrap the actual Fragment metadata objects.

Returns:

getFragments

public List getFragments()
Overridden to make it clear to the implemetor the List returned MUST ContentFragments and not just regular Fragments

Specified by:
getFragments in interface Fragment
Returns:
a collection containing ContentFragment objects

getRenderedContent

public String getRenderedContent()
                          throws IllegalStateException

getRenderedContent

Returns the raw,undecorated content of this fragment. If overridenContent has been set and portlet content has not, overridden content should be returned.

Returns:
The raw,undecorated content of this fragment.
Throws:
IllegalStateException - if the content has not yet been set.

overrideRenderedContent

public void overrideRenderedContent(String contnent)

overrideRenderedContent

Can be used to store errors that may have occurred during the rendering process.

Parameters:
contnent -

setPortletContent

public void setPortletContent(PortletContent portletContent)

setPortletContent

Parameters:
portletContent -


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