|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletDefinition
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 |
---|
ObjectID getId()
java.lang.String getClassName()
java.lang.String getName()
Description getDescription(java.util.Locale locale)
LanguageSet getLanguageSet()
ParameterSet getInitParameterSet()
SecurityRoleRefSet getInitSecurityRoleRefSet()
PreferenceSet getPreferenceSet()
ContentTypeSet getContentTypeSet()
PortletApplicationDefinition getPortletApplicationDefinition()
ServletDefinition getServletDefinition()
DisplayName getDisplayName(java.util.Locale locale)
java.lang.String getExpirationCache()
java.lang.ClassLoader getPortletClassLoader()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |