com.sapportals.portal.navigation

Interface INavigationService

public interface INavigationService

The interface that represents the navigation service. The methods declared in this interface wrap the methods declared in the INavigationConnector interface.

See Also:

INavigationConnector

Field Summary

static String

KEY The key for retrieving an instance of this service.

Method Summary

INavigationNode	getFirstNode(Hashtable environment) Gets the first navigation node in the tree in the highest level of the hierarchy.
NavigationNodes	getInitialNodes(Hashtable environment) Gets the initial nodes from the highest hierarchical level of the navigation connectors registered to the navigation service.
NavigationNodes	getInitialNodesWithInivisible(Hashtable environment) Retrieves all the initial nodes from the highest hierarchical level from all navigation connectors registered to the navigation service, including invisible nodes.
INavigationCacheManager	getNavigationCacheManager()
String	getNavigationNodeHashedName(Hashtable environment, String longName) Gets the node's hashed name from the long name.
String	getNavigationNodeOriginalName(Hashtable environment, String hashedName) Gets the node's long name from the hashed name.
String	getNavNodeParentName(Hashtable environemt, String childNodeURL) Retrieves the URL of the parent node of the supplied node.
INavigationNode	getNode(Hashtable environment, String nodeName) Gets a navigation node specified by its node name.
INavigationNode	getNodeByQuickLink(Hashtable environment, String quickLink) Gets the node specified by a quick link.
NavigationNodes	getNodes(Hashtable environment, Vector connectorNodeNames, boolean isSingleNonnector) Gets the navigation nodes specified by the node names.

Field Detail

KEY

static final String KEY

The key for retrieving an instance of this service.

See Also:

Constant Field Values

Method Detail

getInitialNodes

NavigationNodes getInitialNodes(Hashtable environment)
                                throws NamingException

Gets the initial nodes from the highest hierarchical level of the navigation connectors registered to the navigation service.

Parameters:

environment - the user context

Returns:

a list of the initial nodes

Throws:

NamingException - if the nodes cannnot be found

getInitialNodesWithInivisible

NavigationNodes getInitialNodesWithInivisible(Hashtable environment)
                                              throws NamingException

Retrieves all the initial nodes from the highest hierarchical level from all navigation connectors registered to the navigation service, including invisible nodes. These initial nodes will be presented in the first level of the navigation structure.

Parameters:

environment - containing all environment params the initial nodes are requested for. must at least contain the username.

Returns:

NavigationNodes a list of INavigationNodes representing the initial nodes, including invisible nodes.

Throws:

NamingException

getNode

INavigationNode getNode(Hashtable environment,
                        String nodeName)

Gets a navigation node specified by its node name. The node's name represents a navigation node with information concerning its navigation connector.

Parameters:

nodeName - a node name

environment - the user context

Returns:

the requested node, null if the node was not found

getFirstNode

INavigationNode getFirstNode(Hashtable environment)

Gets the first navigation node in the tree in the highest level of the hierarchy. If the first node of the highest level cannot be launched, the first node in the second level is retrieved.

Parameters:

environment - the user context

Returns:

the first node of the highest level

getNodes

NavigationNodes getNodes(Hashtable environment,
                         Vector connectorNodeNames,
                         boolean isSingleNonnector)

Gets the navigation nodes specified by the node names. The name contains information about the node location in the connector hierarchy.

Parameters:

environment - the user context

connectorNodeNames - a list of the requested nodes names and objects

isSingleNonnector - true if navigation nodes are from a single navigation connector, false if not or unknown

Returns:

NamingEnumeration the navigation nodes, null if the nodes are not found

getNodeByQuickLink

INavigationNode getNodeByQuickLink(Hashtable environment,
                                   String quickLink)

Gets the node specified by a quick link.

Parameters:

environment - the user context

quickLink - a quick link

Returns:

an enumeration containing the nodes

getNavigationNodeHashedName

String getNavigationNodeHashedName(Hashtable environment,
                                   String longName)

Gets the node's hashed name from the long name.

Parameters:

environment - the user context

longName - a long name

Returns:

the hashed name

getNavigationNodeOriginalName

String getNavigationNodeOriginalName(Hashtable environment,
                                     String hashedName)

Gets the node's long name from the hashed name.

Parameters:

environment - the user context

hashedName - a hashed name

Returns:

the long name

getNavigationCacheManager

INavigationCacheManager getNavigationCacheManager()

getNavNodeParentName

String getNavNodeParentName(Hashtable environemt,
                            String childNodeURL)
                            throws NamingException

Retrieves the URL of the parent node of the supplied node. When parent doesn't exists (when supplied node is inital node), a null value is returned

Parameters:

environemt - containing all environment params, must at least contain the username.

childNodeURL - the URL of the child node for which the parent URL is requested.

Returns:

URL of the parent node of the supplied node.

Throws:

NamingException - is thrown if validation checks are done and the recieved node URL is not valid (child node cannot be retrieved).

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/navigation/api	api	EP-PIN