com.ibm.portal.portletmodel.admin
Interface IWidgetWrapperLocator<T extends PortletDefinition>

All Superinterfaces:

Locator<T>

public interface IWidgetWrapperLocator<T extends PortletDefinition>
extends Locator<T>

This Locator can be used to retrieve IWidget wrapper portlet clones.

 final PortletDefinitionList list = ...;
 final Locator loc = list.getLocator();
 if (loc instanceof IWidgetWrapperLocator) {
     final IWidgetWrapperLocator locator = (IWidgetWrapperLocator) loc;
     final ListModel portletDefinitions = locator.getAllForIWidgetURL(url);
 }
 

Since:

7.0.0.0

Method Summary

ListModel<? extends T>	getAllForIWidgetURI(java.net.URI uri) Returns all portlet definitions wrapping a given iwidget definition identified by its iwidget definition URI
ListModel<? extends T>	getAllForIWidgetURL(java.lang.String url) Returns all portlet definitions wrapping a given iwidget definition identified by its iwidget definition URL
ListModel<? extends T>	getAllForIWidgetURL(java.lang.String url, ObjectID staticPageID) Returns all portlet definitions wrapping a given iwidget definition identified by its iwidget definition URL relative to a specific static content page

Methods inherited from interface com.ibm.portal.Locator

findByID, findByUniqueName

Method Detail

getAllForIWidgetURI

ListModel<? extends T> getAllForIWidgetURI(java.net.URI uri)
                                                                     throws ModelException,
                                                                            DataException

Returns all portlet definitions wrapping a given iwidget definition identified by its iwidget definition URI

Parameters:

uri - The iwidget URI

Returns:

a list model with all portlet defintions for the given portlet. If no such portlet exists an empty list model is returned.

Throws:

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

ModelException - if an error occured while accessing model information

getAllForIWidgetURL

ListModel<? extends T> getAllForIWidgetURL(java.lang.String url)
                                                                     throws ModelException,
                                                                            DataException

Returns all portlet definitions wrapping a given iwidget definition identified by its iwidget definition URL

Parameters:

url - The iwidget URL

Returns:

a list model with all portlet defintions for the given portlet. If no such portlet exists an empty list model is returned.

Throws:

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

ModelException - if an error occured while accessing model information

getAllForIWidgetURL

ListModel<? extends T> getAllForIWidgetURL(java.lang.String url,
                                           ObjectID staticPageID)
                                                                     throws ModelException,
                                                                            DataException

Returns all portlet definitions wrapping a given iwidget definition identified by its iwidget definition URL relative to a specific static content page

Parameters:

url - The iwidget URL

staticPageID - The ObjectID of the static content page.

Returns:

a list model with all portlet defintions for the given portlet. If no such portlet exists an empty list model is returned.

Throws:

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

ModelException - if an error occured while accessing model information

See Also:

StaticContentPage