org.apache.pluto.portalImpl.om.page
Interface Fragment

All Known Implementing Classes:
FragmentImpl

public interface Fragment

The Fragment interface represents a single fragment on a site, such as a page, a row, or even a portlet fragment.

The interfaces defined in this package represent an abstract object model (OM) that is applicable for different implementations. The abstract OM defines only how the data is stored and accessed in the memory. Each implementation can store the data in different ways.

This abstraction layer helps to generalize the portlet container from special implementations like data storage and moreover it is not bound to a special Application Server.


Method Summary
 java.lang.String getClassname()
          Returns the classname of the class bound to this fragment.
 java.util.Collection getFragments()
          Returns all fragments used in this node.
 java.lang.String getName()
          Returns the administrative name of this fragment.
 Navigation getNavigation()
          Returns the navigational information linked with this fragment.
 java.util.Collection getProperties()
          Returns all properties describing this fragment.
 java.lang.String getType()
          Returns the type of the class bound to this fragment.
 void setClassname(java.lang.String classname)
          binds a classname to this fragment.
 void setName(java.lang.String name)
          binds an administrative name to this fragment.
 void setNavigation(Navigation navigation)
          binds navigational information to this fragment.
 void setType(java.lang.String type)
          binds a type to this fragment.
 

Method Detail

getName

java.lang.String getName()
Returns the administrative name of this fragment.

Returns:
the administrative name

setName

void setName(java.lang.String name)
binds an administrative name to this fragment.

Parameters:
name - the administrative name

getType

java.lang.String getType()
Returns the type of the class bound to this fragment.

Returns:
the type

setType

void setType(java.lang.String type)
binds a type to this fragment.

Parameters:
type - the type

getClassname

java.lang.String getClassname()
Returns the classname of the class bound to this fragment.

Returns:
the classname

setClassname

void setClassname(java.lang.String classname)
binds a classname to this fragment.

Parameters:
classname - the classname

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

setNavigation

void setNavigation(Navigation navigation)
binds navigational information to this fragment.

Parameters:
navigation - the navigational information

getFragments

java.util.Collection getFragments()
Returns all fragments used in this node. This may be a page fragment or even directly a portlet fragment.

Returns:
a collection containing Fragment objects

getProperties

java.util.Collection getProperties()
Returns all properties describing this fragment. Only the implementation of the "classname" knows how to handle the properties

Returns:
a collection containing Property objects


Copyright © 2003-2010 . All Rights Reserved.