com.ibm.portal.state.accessors.portlet
Interface PortletListAccessor
- All Superinterfaces:
- Accessor, Disposable
-
public interface PortletListAccessor
- extends Accessor
Read-only accessor interface providing methods to query
the set of portlets for which there is any state
information available in the state holder.
- Since:
- 5.1
Method Summary
|
java.util.Collection |
getPortlets()
Get a (potentially unordered) list of ObjectIDs of
portlets that are accessible by this accessor. |
java.util.Collection |
getPortlets(javax.portlet.PortletMode mode)
Get a list of ObjectIDs of portlets that are
currently in the given window state. |
java.util.Collection |
getPortlets(javax.portlet.WindowState state)
Get a list of ObjectIDs of portlets that are
currently in the given window state. |
getPortlets
java.util.Collection getPortlets()
- Get a (potentially unordered) list of ObjectIDs of
portlets that are accessible by this accessor.
- Returns:
- Collection of object ids
getPortlets
java.util.Collection getPortlets(javax.portlet.WindowState state)
- Get a list of ObjectIDs of portlets that are
currently in the given window state. The order of the list
corresponds to the time of the portlet's transition into the
this state.
- Parameters:
- state - window state that should be queried
- Returns:
- A collection of ObjectIDs.
getPortlets
java.util.Collection getPortlets(javax.portlet.PortletMode mode)
- Get a list of ObjectIDs of portlets that are
currently in the given window state. The order of the list
corresponds to the time of the portlet's transition into the
this state.
- Parameters:
- mode - portlet mode that should be queried
- Returns:
- A collection of ObjectIDs.