org.apache.pluto.internal
Interface PortletEntity

All Known Implementing Classes:
PortletEntityImpl

public interface PortletEntity

The PortletEntity encapsulates all data pertaining to a single portlet instance. This instance may appear zero or more times per user. The PortletEntity consists of two primary peices of information, the Portlet Definition as defined by the PortletDD and the Wrapping Servlet information as defined by theServletDD


Method Summary
 String getControllerServletUri()
          Deprecated.  
 InternalPortletPreference[] getDefaultPreferences()
          Returns an array of default preferences of this portlet.
 PortletDD getPortletDefinition()
          Returns the portlet description.
 PreferencesValidator getPreferencesValidator()
          Returns the preferences validator instance for this portlet.
 

Method Detail

getControllerServletUri

String getControllerServletUri()
Deprecated. 

Returns the URI to the controller servlet that wraps this portlet.

Note: this method has been deprecated as of Pluto 1.1.2. Future versions of Pluto will use the PortletInvokerService for resolving the invoker url pattern.

Returns:
the URI to the controller servlet that wraps this portlet.

getDefaultPreferences

InternalPortletPreference[] getDefaultPreferences()
Returns an array of default preferences of this portlet. The default preferences are retrieved from the portlet application descriptor.

Data retrieved from portlet.xml are injected into the domain object PortletPreferenceDD. This method converts the domain objects into PortletPreference objects.

Note that if no value is bound to a given preference key, PortletPreferenceDD.getValues() will return an empty string list, but the value array of PortletPreference should be set to null (instead of an empty array).

This method never returns null, but the values held by PortletPreference may be null.

Returns:
the preference set
See Also:
PortletPreferenceDD

getPortletDefinition

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

Returns:
the portlet description.

getPreferencesValidator

PreferencesValidator getPreferencesValidator()
                                             throws ValidatorException
Returns the preferences validator instance for this portlet. One validator instance is created per portlet definition.

Returns:
the preferences validator instance for this portlet.
Throws:
ValidatorException - if fail to instantiate the validator.


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.