org.apache.pluto.om.portlet
Interface PortletDefinition

All Superinterfaces:
Model

public interface PortletDefinition
extends Model

This interface provides access to a portlet and its attributes. A portlet is defined in the portlet.xml of a portlet application archive file.

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
 java.lang.String getClassName()
          Returns the class name
 ContentTypeSet getContentTypeSet()
          Returns all supported content types of this portlet
 Description getDescription(java.util.Locale locale)
          Returns the description for the given locale The return value may be NULL.
 DisplayName getDisplayName(java.util.Locale locale)
          Returns the display name of this portlet for the given locale.
 java.lang.String getExpirationCache()
          Returns duration (in seconds) of expiration cache
 ObjectID getId()
          Returns the identifier of this portlet as object id.
 ParameterSet getInitParameterSet()
          Returns all parameters of this portlet The return value cannot be NULL.
 SecurityRoleRefSet getInitSecurityRoleRefSet()
          Returns all SecurityRoleRefs of this portlet
 LanguageSet getLanguageSet()
          Returns all resource information of this portlet
 java.lang.String getName()
          Returns the administrative name The return value cannot be NULL.
 PortletApplicationDefinition getPortletApplicationDefinition()
          Returns the PortletApplication object in which this portlet resides The return value cannot be NULL.
 java.lang.ClassLoader getPortletClassLoader()
          Returns the class loader of the portlet The return value may be NULL if the class loader is not yet available.
 PreferenceSet getPreferenceSet()
          Returns all preferences of this portlet
 ServletDefinition getServletDefinition()
          Returns the corresponding servlet to this portlet The return value cannot be NULL.
 

Method Detail

getId

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

Returns:
the object identifier

getClassName

java.lang.String getClassName()
Returns the class name

Returns:
the class name

getName

java.lang.String getName()
Returns the administrative name The return value cannot be NULL.

Returns:
the administrative name

getDescription

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

Returns:
the description

getLanguageSet

LanguageSet getLanguageSet()
Returns all resource information of this portlet

Returns:
the portlet resources

getInitParameterSet

ParameterSet getInitParameterSet()
Returns all parameters of this portlet The return value cannot be NULL.

Returns:
the parameter set

getInitSecurityRoleRefSet

SecurityRoleRefSet getInitSecurityRoleRefSet()
Returns all SecurityRoleRefs of this portlet

Returns:
the SecurityRoleRef set

getPreferenceSet

PreferenceSet getPreferenceSet()
Returns all preferences of this portlet

Returns:
the preference set

getContentTypeSet

ContentTypeSet getContentTypeSet()
Returns all supported content types of this portlet

Returns:
the content type set

getPortletApplicationDefinition

PortletApplicationDefinition getPortletApplicationDefinition()
Returns the PortletApplication object in which this portlet resides The return value cannot be NULL.

Returns:
the PortletApplication object of this portlet

getServletDefinition

ServletDefinition getServletDefinition()
Returns the corresponding servlet to this portlet The return value cannot be NULL.

Returns:
a servlet object

getDisplayName

DisplayName getDisplayName(java.util.Locale locale)
Returns the display name of this portlet for the given locale. The return value may be NULL.

Returns:
display name for the given locale

getExpirationCache

java.lang.String getExpirationCache()
Returns duration (in seconds) of expiration cache

Returns:
duration of expiration cache

getPortletClassLoader

java.lang.ClassLoader getPortletClassLoader()
Returns the class loader of the portlet The return value may be NULL if the class loader is not yet available.

Returns:
java.util.ClassLoader


Copyright © 2003-2009 . All Rights Reserved.