Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.portal.state.accessors.solo
Interface SoloAccessorController
- All Superinterfaces:
- Accessor, Disposable, SoloAccessor
public interface SoloAccessorController- extends SoloAccessor
Controller interface providing a method to store the ObjectID of the portlet that has switched to SOLO window state.
- Since:
- 5.1
- See Also:
- SoloAccessor
Method Summary void removeSoloPortlet()
Removes the current portlet from solo state as well as the associated return selection information.void setReturnSelection(ObjectID aSelection)
Stores the given ObjectID representing a selection into the state holder this accessor operates on.void setReturnSelection(java.lang.String aUniqueName)
Stores the given String representing a selection into the state holder this accessor operates on.void setSoloPortlet(ObjectID aPortletId)
Writes the ObjectID of the portlet whose window state has changed to Solo state into the state holder this accessor operates on.void setSoloPortlet(java.lang.String uniqueName)
Writes the unique name of the portlet whose window state has changed to Solo state into the state holder this accessor operates on.
Methods inherited from interface com.ibm.portal.state.accessors.solo.SoloAccessor getReturnSelection, getSoloPortlet
Methods inherited from interface com.ibm.portal.Disposable dispose
Method Detail setSoloPortlet
void setSoloPortlet(ObjectID aPortletId)
- Writes the ObjectID of the portlet whose window state has changed to Solo state into the state holder this accessor operates on. To leave the solo state just transmit null.
- Parameters:
- aPortletId - The ObjectID of the portlet in Solo window state. May be null.
setSoloPortlet
void setSoloPortlet(java.lang.String uniqueName) throws MissingUniqueNameException, UnknownUniqueNameException
- Writes the unique name of the portlet whose window state has changed to Solo state into the state holder this accessor operates on. To leave the solo state just transmit null.
- Parameters:
- uniqueName - The unique name of the portlet in Solo window state. May be null.
- Throws:
- UnknownUniqueNameException - - the unique name could not be mapped to an object ID
- MissingUniqueNameException - - the unique name was null or empty
setReturnSelection
void setReturnSelection(ObjectID aSelection)
- Stores the given ObjectID representing a selection into the state holder this accessor operates on. The selection corresponds to the page the portal selects when leaving the solo state of the respective portlet.
- Parameters:
- aSelection - ObjectID representing the selection the portal will use when leaving solo state. May be null.
setReturnSelection
void setReturnSelection(java.lang.String aUniqueName) throws MissingUniqueNameException, UnknownUniqueNameException
- Stores the given String representing a selection into the state holder this accessor operates on. The selection corresponds to the page the portal selects when leaving the solo state of the respective portlet.
- Parameters:
- aSelection - String representing the selection the portal will use when leaving solo state. May be null.
- Throws:
- UnknownUniqueNameException - - the unique name could not be mapped to an object ID
- MissingUniqueNameException - - the unique name was null or empty
removeSoloPortlet
void removeSoloPortlet()
- Removes the current portlet from solo state as well as the associated return selection information. As a result, no portlet will be in solo.
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD