com.ibm.portal.portletmodel.admin
Interface PortletLocator<E extends java.lang.Object & Portlet>

All Superinterfaces:

Locator<E>

public interface PortletLocator<E extends java.lang.Object & Portlet>
extends Locator<E>

A locator the can be provided by 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<E>

getAllForWebApplication(WebApplication aWebApp) Returns all portlets that are associated with the given web application

Methods inherited from interface com.ibm.portal.Locator

findByID, findByUniqueName

Method Detail

getAllForWebApplication

ListModel<E> getAllForWebApplication(WebApplication aWebApp)
                                                                       throws ModelException,
                                                                              DataException

Returns all portlets that are associated with the given web application

Returns:

a list model with all portlets for the given web application; never returns null.

Throws:

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

ModelException - if an error occurred while accessing model information