Package com.ibm.portal.portletmodel

This package defines interfaces for the portal's representation of portlets and their configuration data.

See:
          Description

Interface Summary
CommunicationDatatype Interface that describes the semantics of data transferred by the property broker.
CommunicationEndpoint Interface that describes a communication endpoint for property broker.
CommunicationEndpointLocator<E extends Object & CommunicationEndpoint> A locator for finding CommunicationEndpoints in a portlet model.
CommunicationEndpointProvider<E extends Object & CommunicationEndpoint> Interface describing a container of communication endpoints.
CommunicationSource Interface that describes a communication endpoint that can publish data for distribution by property broker.
CommunicationTarget Interface that describes a communication endpoint that can receive data from property broker.
Portlet Interface that represents the deployed code unit for a portlet, as specified in the deployment descriptor.
PortletDefinition Interface that represents administrator settings for a portlet.
PortletEntity Interface that represents user settings for a portlet.
PortletModel This interface provides access to the model for the different levels of portlet configuration.
PortletPreferences<E extends Map.Entry<java.lang.String,java.lang.String>> An interface describing portlet preferences.
PortletPreferencesProvider<E extends Object & Map.Entry<java.lang.String,java.lang.String>> An interface describing a method to obtain portlet preferences for a resource.
PortletWindow Interface that represents a particular view on a portlet.
ProcessingEventDefinition Interface for a communication target that is a JSR 286 event definition.
PublicRenderParameter Interface that models the definition of a public render parameter.
PublicRenderParameterHierarchyProvider Interface to obtain a PublicRenderParameterProvider for a given resource.
PublicRenderParameterList<T extends PublicRenderParameter> A searchable and iterable list containing PublicRenderParameter objects.
PublicRenderParameterLocator<T extends PublicRenderParameter> Locator which can be used to look up a public render parameter based on its global (or alias) name or its local identifier.
PublicRenderParameterProvider Interface to access the public render parameters of a portlet.
PublishingEventDefinition Interface for a communication source that is a JSR 286 event definition.
WebApplication Interface that represents a deployed web application in the underlying application server containing one or more portlets.
 

Package com.ibm.portal.portletmodel Description

This package defines interfaces for the portal's representation of portlets and their configuration data.

Package Specification

The PortletModel represents portlets and their configuration data in the portal. The model is specific to a given user, i.e. the portlet model might look different to different users due to access control settings.
The portlet model has hierarchical structure and contains the following types:

The portlet model allows to traverse this hierarchical strcuture from the leaves to the roots, e.g to find out the web application associated with a given portlet window.

The upper three types of this hierarchical structure (web application, portlet and portlet definition) are global; this means that, for example, any portlet definition that is visible to a particular user will be contained in any portlet model for that user. The interfaces in the com.ibm.portal.portletmodel.admin package provide extended possiblities to traverse these global levels.
Portlet entities and portlet windows are not global, but associated with a specific presentation structure. That means that a portlet model can only be retrieved in the context of a specific presentation module (represented by a ContentPage) or a portlet window. Other portlet entities and windows may not be accessible in the same model, even if they are visible to the same user.