com.ibm.portal.content
Interface ControlLocator<E extends java.lang.Object & LayoutNode>

All Superinterfaces:

Locator<E>

public interface ControlLocator<E extends java.lang.Object & LayoutNode>
extends Locator<E>

A locator for finding LayoutControls in a layout model. This locator interface is optionally implemented by LayoutModel implementations.

Since:

5.1.0.1

Method Summary

ListModel<LayoutControl>	findAllControls() Finds all layout nodes representing a control on the layout model for this page.
ListModel<LayoutControl>	findControlByConcretePortletID(ObjectID aConcretePortletObjectID) Deprecated. use findControlByPortletEntityID(ObjectID) instead Finds the layout node representing a control that holds the concrete portlet with the given object ID.
ListModel<LayoutControl>	findControlByPortletDefinitionID(ObjectID aPortletDefinitionID) Finds the layout node representing a control that is backed by a portlet definition of the given ID.
ListModel<LayoutControl>	findControlByPortletEntityID(ObjectID aPortletEntityID) Finds the layout node representing a control that is backed by a portlet entity of the given ID.
ListModel<LayoutControl>	findControlByPortletInstanceID(ObjectID aPortletInstanceObjectID) Deprecated. use findControlByPortletDefinitionID(ObjectID) instead Finds the layout node representing a control that holds the portlet instance with the given object ID.

Methods inherited from interface com.ibm.portal.Locator

findByID, findByUniqueName

Method Detail

findControlByPortletInstanceID

ListModel<LayoutControl> findControlByPortletInstanceID(ObjectID aPortletInstanceObjectID)

Deprecated. use findControlByPortletDefinitionID(ObjectID) instead Finds the layout node representing a control that holds the portlet instance with the given object ID.

Parameters:

aPortletInstanceObjectID - the object ID of the portlet instance

Returns:

a list model containing the LayoutNode(s) holding the portlet instance with the given object ID or an empty list.

findControlByConcretePortletID

ListModel<LayoutControl> findControlByConcretePortletID(ObjectID aConcretePortletObjectID)

Deprecated. use findControlByPortletEntityID(ObjectID) instead Finds the layout node representing a control that holds the concrete portlet with the given object ID.

Parameters:

aConcretePortletObjectID - the object ID of the concrete portlet

Returns:

a list model containing the LayoutNode(s) holding the concrete portlet with the given object ID or an empty list.

findAllControls

ListModel<LayoutControl> findAllControls()

Finds all layout nodes representing a control on the layout model for this page. The order of controls is not defined.

Returns:

a list model containg all LayoutControls of this layout model, never null. The order of the elements is not defined.

findControlByPortletEntityID

ListModel<LayoutControl> findControlByPortletEntityID(ObjectID aPortletEntityID)

Finds the layout node representing a control that is backed by a portlet entity of the given ID.

Parameters:

aPortletEntityID - the object ID of the portlet entity

Returns:

a list model containing LayoutControls whose portlet entity has the requested ID, never null. The order of controls is not defined.

findControlByPortletDefinitionID

ListModel<LayoutControl> findControlByPortletDefinitionID(ObjectID aPortletDefinitionID)

Finds the layout node representing a control that is backed by a portlet definition of the given ID.

Parameters:

aPortletDefinitionID - the object ID of the portlet definition

Returns:

a list model containing LayoutControls whose portlet definition has the requested ID, never null. The order of controls is not defined.