com.sapportals.portal.navigation
Interface INavigationConnector

public interface INavigationConnector

 Copyright(c) 2003 SAP.  All Rights Reserved.

 Description:  INavigationConnector interface should be implemented by 
 anyone who would like to implement a connector. Each of the navigation steps 
 calls at least one of these methods as implemented by the connector.


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















Method Summary




 javax.naming.NamingEnumeration
getInitialNodes(java.util.Hashtable environment)



          Retrieves all the initial nodes of the connector.



 INavigationConnectorNode
getNode(java.util.Hashtable environment,
        java.lang.String connectorNodeName)



          Retrieves a Navigation Node by it's name. 



 javax.naming.NamingEnumeration
getNodes(java.util.Hashtable environment,
         java.util.Vector connectorNodeNames)



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


 











Method Detail



getInitialNodes
public javax.naming.NamingEnumeration getInitialNodes(java.util.Hashtable environment)

Retrieves all the initial nodes of the connector.

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





getNode
public INavigationConnectorNode getNode(java.util.Hashtable environment,
                                        java.lang.String connectorNodeName)

Retrieves a Navigation Node by it's name. 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.
connectorNodeName - the hierarchy of the reuqested node.
Returns:
the requested node or null if wasn't found.





getNodes
public javax.naming.NamingEnumeration getNodes(java.util.Hashtable environment,
                                               java.util.Vector connectorNodeNames)

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.
Returns:
NamingEnumeration bindings of INavigationConnectorNode objects, if recieved nodes are not
 found, They are not returned.