com.ibm.portal.state.accessors.solo
Interface SoloAccessor

All Superinterfaces:

Accessor, Disposable

All Known Subinterfaces:

SoloAccessorController

public interface SoloAccessor
extends Accessor

Interface providing read-access to Solo information. The state includes as maximum one portlet in SOLO mode. This portlet will be displayed as the only portlet without any additional navigation information. SOLO can be used to implements popup windows that display only the content of one single portlet or modal dialogs.

SOLO is a portal state and not a portlet window state of a specific portlet. In order to provide the portlet with the information that the portal is currently in SOLO mode and the current portlet is the selected portlet the SOLO mode is provided as portlet window state to the portlet.

Since:

5.1

Method Summary

ObjectID	getReturnSelection() Returns the ObjectID representing the selection that has been associated with the portlet being in solo state.
ObjectID	getSoloPortlet() Returns the ObjectID of the portlet window which is in Solo state.

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

getSoloPortlet

ObjectID getSoloPortlet()
                        throws InvalidPortletIdException

Returns the ObjectID of the portlet window which is in Solo state. If there is no such portlet, the method will return null.

Returns:

The ObjectID of the portlet which is in Solo window state (if any).

Throws:

InvalidPortletIdException - if the portlet's identifier could not be converted to ObjectID.

getReturnSelection

ObjectID getReturnSelection()
                            throws InvalidSelectionException

Returns the ObjectID representing the selection that has been associated with the portlet being in solo state. In general, the selection corresponds to the page that will be displayed when leaving the solo state of the respective portlet. If there is no such selection information available, the method will return null.

Returns:

The ObjectID of the selection that has been associated with the respective portlet being in Solo state (if any).

Throws:

InvalidSelectionException - if the selection identifier could not be converted to ObjectID.