|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SoloAccessorController
Controller interface providing a method to
store the ObjectID
of the portlet
that has switched to SOLO window state.
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 |
---|
void setSoloPortlet(ObjectID aPortletId)
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
.
aPortletId
- The ObjectID
of
the portlet in Solo window state. May be null
.void setSoloPortlet(java.lang.String uniqueName) throws MissingUniqueNameException, UnknownUniqueNameException
null
.
uniqueName
- The unique name of
the portlet in Solo window state. May be null
.
UnknownUniqueNameException
- - the unique name could not be mapped to an object ID
MissingUniqueNameException
- - the unique name was null or emptyvoid setReturnSelection(ObjectID aSelection)
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.
aSelection
- ObjectID
representing the selection the portal
will use when leaving solo state. May be null
.void setReturnSelection(java.lang.String aUniqueName) throws MissingUniqueNameException, UnknownUniqueNameException
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.
aSelection
- String
representing the selection the portal
will use when leaving solo state. May be null
.
UnknownUniqueNameException
- - the unique name could not be mapped to an object ID
MissingUniqueNameException
- - the unique name was null or emptyvoid removeSoloPortlet()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |