com.ibm.portal.portletmodel
Interface PortletDefinition

All Superinterfaces:

Identifiable, Localized, MetaDataProvider, PortletPreferencesProvider

All Known Subinterfaces:

ModifiablePortletDefinition

public interface PortletDefinition
extends Identifiable, PortletPreferencesProvider, Localized

Interface that represents administrator settings for a portlet. A portlet definition provides localized titles and descriptions and an administrative level of preferences for portlets. The administrative preferences are used as a fallback for preferences that are not set or overridden by user preferences in a PortletEntity. In CONFIG mode, portlets read and write directly to and from the administrative preferences.

As a result of cloning the portlet, multiple portlet definitions may exist for the same portlet; each of these definitions parametrizes the deployed portlet with different titles and administrative preferences.

Note for IBM Portlets: the PortletPreferencesProvider.getPortletPreferencesLayer() method returns the portlet settings for IBM portlets.

Since:

6.0.1

Method Summary

CommunicationEndpointProvider

getEndpointProvider() Returns the CommunicationEndpointProvider which may be used to load the CommunicationEndpoints this portlet offers.

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Methods inherited from interface com.ibm.portal.portletmodel.PortletPreferencesProvider

getMetaData, getPortletPreferencesLayer

Methods inherited from interface com.ibm.portal.Localized

getDescription, getLocales, getTitle

Method Detail

getEndpointProvider

CommunicationEndpointProvider getEndpointProvider()

Returns the CommunicationEndpointProvider which may be used to load the CommunicationEndpoints this portlet offers.

Returns:

a CommunicationEndpointProvider