|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SelectionAccessorController
Interface providing read and write access to selection information stored within the state holder.
SelectionAccessor
Method Summary | |
---|---|
java.util.Map<java.lang.String,java.lang.String[]> |
getParameters()
Returns a modifiable map containing generic selection parameters. |
java.util.Map<ObjectID,ObjectID> |
getSelectionMappings()
Returns a modifiable map of selection mappings |
void |
setFocus(java.lang.String aFocusID)
Sets the ID of the currently focussed item |
void |
setSelection(ObjectID nodeID)
Sets the currently selected node into the state holder. |
void |
setSelection(java.lang.String uniqueNameID)
Sets the currently selected node into the state holder. |
void |
setSelection(java.net.URI aURI)
Sets the selection to the URI |
void |
setSelectionMapping(ObjectID aNavNode,
ObjectID aResource)
Modifies the mapping between two navigation nodes. |
void |
setSelectionMapping(java.lang.String aNavNode,
java.lang.String aResource)
Modifies the mapping between two navigation nodes. |
Methods inherited from interface com.ibm.portal.state.accessors.selection.SelectionAccessor |
---|
getFocus, getSelection, getSelectionMapping, getSelectionMapping, getSelectionURI |
Methods inherited from interface com.ibm.portal.Disposable |
---|
dispose |
Method Detail |
---|
java.util.Map<java.lang.String,java.lang.String[]> getParameters()
String
String[])-mappings.
getParameters
in interface SelectionAccessor
null
.java.util.Map<ObjectID,ObjectID> getSelectionMappings()
getSelectionMappings
in interface SelectionAccessor
void setFocus(java.lang.String aFocusID)
aFocusID
- the ID or null
void setSelection(ObjectID nodeID) throws CannotInsertSelectionNodeException
ObjectID
of the previous selected node will be overridden.
Passing in null
removes the selection information from the
state holder.
nodeID
- The ObjectID
of the navigation node which has
been selected. May be null
.
CannotInsertSelectionNodeException
- If the given ObjectID
cannot be inserted into
the state holder.void setSelection(java.lang.String uniqueNameID) throws CannotInsertSelectionNodeException, MissingUniqueNameException, UnknownUniqueNameException
ObjectID
of the previous selected node will be overridden.
uniqueNameID
- The unique name of the navigation node which has been
selected. Must not be null
.
UnknownUniqueNameException
- If the unique name could not be mapped to an
ObjectID
.
MissingUniqueNameException
- If the unique name was null
or empty.
CannotInsertSelectionNodeException
- If the given ObjectID
cannot be inserted into
the state holder.void setSelection(java.net.URI aURI) throws CannotInsertSelectionNodeException
aURI
-
CannotInsertSelectionNodeException
void setSelectionMapping(ObjectID aNavNode, ObjectID aResource)
null
as aResource
aNavNode
- An ObjectID
of a naviagation node. Must not be
null
.aResource
- An ObjectID
of a resource. May be
null
.void setSelectionMapping(java.lang.String aNavNode, java.lang.String aResource) throws MissingUniqueNameException, UnknownUniqueNameException
null
as aResource
aNavNode
- The unique name of a navigation node. Must not be
null
.aResource
- The unique name of a resource. May be null
.
UnknownUniqueNameException
- If the unique name could not be mapped to an
ObjectID
.
MissingUniqueNameException
- If the unique name was null
or empty.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |