com.sapportals.portal.navigation
Interface INavigationService

public interface INavigationService

 Copyright(c) 2002 SAP.  All Rights Reserved.

 Description:  INavigationService interface is the main interface for the navigation model.  
 The APIs declared in this interface usually wrap the APIs declared in the INavigationConnector interface. 
 Thus, some of the APIs in this interface has exactly the same signature 
 as the ones in INavigationConnector, and the others expose a different signature 
 APIs for simplicity.


Version: 
1.0
See Also: 
com.sapportals.portal.navigation.INavigationConnector, 
com.sapportals.portal.navigation.NavigationService









Field Summary




static java.lang.String
KEY



           


 






Method Summary




 INavigationNode
getFirstNode(java.util.Hashtable environment)



          Retrieves the first Navigation Node in the tree in the highest level of hiererchy. 



 NavigationNodes
getInitialNodes(java.util.Hashtable environment)



          Retrieves all the initial nodes from the highest hierarchical level from all Navigation
 Connectors registered to the navigation service.



 INavigationNode
getNode(java.util.Hashtable environment,
        java.lang.String nodeName)



          Retrieves a Navigation Node by it's hierarcial name. 



 NavigationNodes
getNodes(java.util.Hashtable environment,
         java.util.Vector connectorNodeNames,
         boolean isSingleNonnector)



          Retrieves a Navigation Nodes which their names are contained in the
 received vector. 


 





Field Detail



KEY
public static final java.lang.String KEY









Method Detail



getInitialNodes
public NavigationNodes getInitialNodes(java.util.Hashtable environment)
                                throws javax.naming.NamingException

Retrieves all the initial nodes from the highest hierarchical level from all Navigation
 Connectors registered to the navigation service.

Parameters:
environment - containing all environment params the initial nodes are requested for.
 must at least contain the username.
Returns:
a list of the initial nodes.





getNode
public INavigationNode getNode(java.util.Hashtable environment,
                               java.lang.String nodeName)

Retrieves a Navigation Node by it's hierarcial name. The node's name
 represents a navigation node with the information concerning it's
 navigation connector.

Parameters:
nodeName - name of the requested node.
environment - containing all environment params the initial nodes are requested for.
 must at least contain the username.
Returns:
requested node or null if node wasn't found.





getFirstNode
public INavigationNode getFirstNode(java.util.Hashtable environment)

Retrieves the first Navigation Node in the tree in the highest level of hiererchy. If first node of
 highest level is not launch able, the first node in the second level is retrieved.

Parameters:
environment - containing all environment params the initial nodes are requested for.
 must at least contain the username.
Returns:
first node of highest level. If first node in highest level is not launch able,
 the first node in the second level is retrieved.





getNodes
public NavigationNodes getNodes(java.util.Hashtable environment,
                                java.util.Vector connectorNodeNames,
                                boolean isSingleNonnector)

Retrieves a Navigation Nodes which their names are contained in the
 received vector. The name contains information about the node location in
 the connector hierarchy.

Parameters:
environment - containing all environment params the initial nodes are requested for.
 must at least contain the username.
connectorNodeNames - list of the requested nodes names and objects.
isSingleNonnector - indicates whether all navigation nodes for retrieval are from single navigation connector. If this datum is unknown, a false value should be set.
Returns:
NamingEnumeration bindings of INavigationConnectorNode objects, if recieved nodes are not
 found, They are not returned.