com.ibm.portal.portletmodel.admin
Interface PortletLocator

All Superinterfaces:

Locator

public interface PortletLocator
extends Locator

A locator the can be provided by com.ibm.portal.portletmodel.admin">PortletList implementations. The locator is optionally implemented by a portlet list.

Code example:

 final PortletList list = ...;
 final Locator loc = list.getLocator();
 if (loc instanceof PortletLocator) {
     final PortletLocator locator = (PortletLocator) loc;
     final ListModel portlets = locator.getAllForWebApplication(aWebApplication);
 }
 

Since:

6.0.1

Method Summary

ListModel

com.ibm.portal.portletmodel.WebApplication)">getAllForWebApplication(WebApplication aWebApp) Returns all portlet definitions that are associated with the given portlet

Methods inherited from interface com.ibm.portal.Locator

findByID, findByUniqueName

Method Detail

com.ibm.portal.portletmodel.WebApplication)">

getAllForWebApplication

ListModel getAllForWebApplication(WebApplication aWebApp)
                                  throws ModelException,
                                         DataException

Returns all portlet definitions that are associated with the given portlet

Returns:

a list model with all portlet definitions for the given portlet; never returns null.

Throws:

DataException - if a database error occurs while accessing the data backend

ModelException - if an error occured while accessing model information