com.ibm.portal.content
Interface AddablePortletsLocator<E>

All Superinterfaces:

Locator<E>

public interface AddablePortletsLocator<E>
extends Locator<E>

A locator for finding ObjectIDs of PortletDefinitions that may be added to a LayoutModel of a ContentPage.
This method exposes the ObjectIDs of all portlet definitions that can be added to a layout model whereas com.ibm.portal.content.LayoutModel.getAllowedPortlets() and com.ibm.portal.content.LayoutModel.getAllAllowedPortlets() expose the ids that are allowed (this can be configured). The allowed portlet list may be a subset of the addable portlet list, as well the allowed portlet list may not be set, which means that from a configuration point of view all portlets are allowed.

Since:

6.1.0.3

Method Summary

IterableListModel<ObjectID>

getAddablePortlets() Returns a list of object IDs of portlet definitions that can be added to the object implementing this interface, potentially a com.ibm.portal.content.LayoutModel.

Methods inherited from interface com.ibm.portal.Locator

findByID, findByUniqueName

Method Detail

getAddablePortlets

IterableListModel<ObjectID> getAddablePortlets()
                                               throws ModelException

Returns a list of object IDs of portlet definitions that can be added to the object implementing this interface, potentially a com.ibm.portal.content.LayoutModel.

Returns:

a list model containing object IDs of addable portlets, never null, but could be empty.

Throws:

ModelException - if an error occured while accessing the database