com.sapportals.portal.navigation

Interface INavigationConnectorNamingHandler

All Known Implementing Classes:

DefaultNavigationNamingHandler

public interface INavigationConnectorNamingHandler

The interface that determines how the name of the nodes are constructed. The name should be built according to the syntax of the naming interface that the nodes are stored in (for example, LDAP, JNDI, File System).
The naming handler implementation is declared for each connector in the INavigationConnectorRegistration.registerConnector method. A default naming handler is implemented by the navigation. This implementation handles names according to the UNIX syntax ("/" is a separator, "." is a pointer to the current directory, ".." is a pointer to a parent directory, etc).
A connector may use this default implementation, or it can implement a naming handler of its own.
Note: If registerConnector is not provided with an implementation of INavigationConnectorNamingHandler, the default naming handler is used.

See Also:

DefaultNavigationNamingHandler

Method Summary

String

composeName(Hashtable environment, String baseNodeURL, int numberOfLevelsUp, String[] children) Creates the name of the navigation target node specified by a base navigation node and a relative path to the target node.

Method Detail

composeName

String composeName(Hashtable environment,
                   String baseNodeURL,
                   int numberOfLevelsUp,
                   String[] children)
                   throws NamingException

Creates the name of the navigation target node specified by a base navigation node and a relative path to the target node. The caller to this method only needs to know where the target node is located relative to the current node.
For example: In order to navigate from
pcd:role1/folder1/folder2/folder3/workset1/page1

to

pcd:role1/folder1/folder2/folder4/workset2/page2

use the following to get the target navigation node:

composeName ("pcd:role1/folder1/folder2/folder3/workset1/page1", 3, {"folder4", "workset2", "page2"});

Parameters:

environment - the user context

baseNodeURL - the URL of the active node

numberOfLevelsUp - the number of levels of parents to search

children - an array of the atomic names of the children (including the target node)

Returns:

the name of the relative node

Throws:

NamingException - if a validation check is done and the active node does not exist

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