+

Search Tips   |   Advanced Search

 PREV CLASS   NEXT CLASS
Tree 
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ibm.portal.state.accessors.selection
Interface SelectionAccessorController

All Superinterfaces:
Accessor, Disposable, SelectionAccessor
public interface SelectionAccessorController
extends SelectionAccessor

Interface providing read and write access to selection information stored within the state holder.

Since:
5.1
See Also:
SelectionAccessor

Method Summary
 java.util.Map<java.lang.String,java.lang.String[]> getParameters()
          Return a modifiable map containing generic selection parameters.
 java.util.Map<ObjectID,ObjectID> getSelectionMappings()
          Return 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

getParameters

java.util.Map<java.lang.String,java.lang.String[]> getParameters()
Returns a modifiable map containing generic selection parameters. Returns an empty map if there are no such parameters. The parameters are represented as (String
Specified by:
getParameters in interface SelectionAccessor
Returns:
The selection parameter map. Not null.
Since:
6.0.1

getSelectionMappings

java.util.Map<ObjectID,ObjectID> getSelectionMappings()
Returns a modifiable map of selection mappings

Specified by:
getSelectionMappings in interface SelectionAccessor
Returns:
the mappings
Since:
8.5

setFocus

void setFocus(java.lang.String aFocusID)
Sets the ID of the currently focussed item

Parameters:
aFocusID - the ID or null
Since:
8.5

setSelection

void setSelection(ObjectID nodeID)
                  throws CannotInsertSelectionNodeException
Sets the currently selected node into the state holder. The ObjectID of the previous selected node will be overridden. Passing in null removes the selection information from the state holder.

Parameters:
nodeID - The ObjectID of the navigation node which has been selected. May be null.
Throws:
CannotInsertSelectionNodeException - If the given ObjectID cannot be inserted into the state holder.

setSelection

void setSelection(java.lang.String uniqueNameID)
                  throws CannotInsertSelectionNodeException,
                         MissingUniqueNameException,
                         UnknownUniqueNameException
Sets the currently selected node into the state holder. The ObjectID of the previous selected node will be overridden.

Parameters:
uniqueNameID - The unique name of the navigation node which has been selected. Must not be null.
Throws:
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.

setSelection

void setSelection(java.net.URI aURI)
                  throws CannotInsertSelectionNodeException
Sets the selection to the URI

Parameters:
aURI -
Throws:
CannotInsertSelectionNodeException
Since:
6.1.0

setSelectionMapping

void setSelectionMapping(ObjectID aNavNode,
                         ObjectID aResource)
Modifies the mapping between two navigation nodes. If the mapping does not exist so far, a new one will be created. To delete a mapping insert null as aResource

Parameters:
aNavNode - An ObjectID of a naviagation node. Must not be null.
aResource - An ObjectID of a resource. May be null.

setSelectionMapping

void setSelectionMapping(java.lang.String aNavNode,
                         java.lang.String aResource)
                         throws MissingUniqueNameException,
                                UnknownUniqueNameException
Modifies the mapping between two navigation nodes. If the mapping does not exist so far, a new one will be created. To delete a mapping insert null as aResource

Parameters:
aNavNode - The unique name of a navigation node. Must not be null.
aResource - The unique name of a resource. May be null.
Throws:
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
Tree 
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD