org.apache.pluto.portalImpl.aggregation
Interface Fragment

All Known Implementing Classes:

AbstractFragment, AbstractFragmentContainer, AbstractFragmentSingle, AbstractNavigationFragment, ColumnFragment, PageFragment, PortletFragment, RootFragment, RowFragment, TabNavigation

public interface Fragment

Method Summary

void	addChild(Fragment child) Adds an child to the fragment
void	createURL(PortalURL url) Creates an URL pointing to this fragment
java.util.Collection	getChildFragments() Returns a collection of all child fragments
java.lang.String	getId() Returns the identifier of this fragment.
Parameters	getInitParameters() Returns the initialization parameters of this fragment
Navigation	getNavigation() Returns the navigational information linked with this fragment.
Fragment	getParent() Returns the parent fragment.
boolean	isPartOfURL(PortalURL url) Returns true if the fragment is part of the URL
void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Is called to render the fragment.

Method Detail

service

void service(javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response)
             throws javax.servlet.ServletException,
                    java.io.IOException

Is called to render the fragment. This may be a page, column or even a portlet.

Parameters:

request - the servlet request

response - the servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

getId

java.lang.String getId()

Returns the identifier of this fragment. Mostly this is a name visible in the Portal URL.

Returns:

the identifier of this fragment

getParent

Fragment getParent()

Returns the parent fragment. If this fragment is the root fragment the return value is NULL

Returns:

the parent fragment or NULL if this is the root fragment

getInitParameters

Parameters getInitParameters()

Returns the initialization parameters of this fragment

Returns:

the init parameters

getChildFragments

java.util.Collection getChildFragments()

Returns a collection of all child fragments

Returns:

a collection containing objects implementing the interface fragment

addChild

void addChild(Fragment child)

Adds an child to the fragment

Parameters:

child - the child fragment

getNavigation

Navigation getNavigation()

Returns the navigational information linked with this fragment. The return value may be NULL, if no navigational information is defined.

Returns:

the navigational information

createURL

void createURL(PortalURL url)

Creates an URL pointing to this fragment

Parameters:

url - the PortalURL object used

isPartOfURL

boolean isPartOfURL(PortalURL url)

Returns true if the fragment is part of the URL

Parameters:

url - the PortalURL object used

Returns:

true if the fragment is part of the URL