org.apache.pluto.om.entity
Interface PortletEntity

All Superinterfaces:
Model

public interface PortletEntity
extends Model

The PortletEntity interface represents a single portlet occurance, that can be shown on a single page or on multiple pages.

This interface defines the model as known from the MVC pattern. Its purpose is to provide read access to the data stored in the model.


Method Summary
 Description getDescription(java.util.Locale locale)
          Returns the description of this portlet entity for the given locale.
 ObjectID getId()
          Returns the identifier of this portlet instance as object id.
 PortletApplicationEntity getPortletApplicationEntity()
          Returns the parent application instance of this portlet instance The return value cannot be NULL.
 PortletDefinition getPortletDefinition()
          Returns the portlet description The return value cannot be NULL.
 PortletWindowList getPortletWindowList()
          Get a list with all windows which belong to this portlet instance The return value cannot be NULL.
 PreferenceSet getPreferenceSet()
          Returns all preferences of this portlet The return value cannot be NULL.
 

Method Detail

getId

ObjectID getId()
Returns the identifier of this portlet instance as object id. The return value cannot be NULL.

Returns:
the object identifier

getPreferenceSet

PreferenceSet getPreferenceSet()
Returns all preferences of this portlet The return value cannot be NULL.

Returns:
the preference set

getPortletDefinition

PortletDefinition getPortletDefinition()
Returns the portlet description The return value cannot be NULL.

Returns:
the portlet description

getPortletApplicationEntity

PortletApplicationEntity getPortletApplicationEntity()
Returns the parent application instance of this portlet instance The return value cannot be NULL.

Returns:
the parent application instance

getPortletWindowList

PortletWindowList getPortletWindowList()
Get a list with all windows which belong to this portlet instance The return value cannot be NULL.

Returns:
PortletWindowList with all windows

getDescription

Description getDescription(java.util.Locale locale)
Returns the description of this portlet entity for the given locale. The return value may be NULL.

Returns:
the description for the given locale


Copyright © 2003-2011 . All Rights Reserved.