com.sapportals.portal.navigation

Interface IClientNavigationGenerator

All Known Subinterfaces:

INavigationGenerator

public interface IClientNavigationGenerator

The interface that generates the JavaScript code (doNavigate() method) that navigates to a specific navigation node.

Field Summary

static int	SHOW_EXTERNAL A constant that defines the launch mode for launching in an external, new, standalone window.
static int	SHOW_EXTERNAL_PORTAL A constant that defines the launch mode for launching in an external, new portal window.
static int	SHOW_INPLACE A constant that defines the launch mode for launching in the same window.

Method Summary

String	createAbsoluteNavigateClientCall(String navTarget, int mode, String winFeatures, String winName) Deprecated. As of EP 7.1 Replaced by createAbsoluteNavigateClientCall(String, NavigationParameters, NavigationSettings)
com.sapportals.portal.navigation.INavigationLink	createAbsoluteNavigateClientCall(String navTarget, com.sapportals.portal.navigation.NavigationParameters navigationParameters, com.sapportals.portal.navigation.NavigationSettings navigationSettings) Creates a client call for Absolute navigate operation to the navigation target
String	createObjectNavigateClientCall(String systemAlias, String businessObjName, String objValue, String operation) Creates a client call for Object Based navigate operation.
String	createRelativeNavigateClientCall(String currentNode, int numOfLevelsUp, String[] atomicChildNodes, int mode, String winFeatures, String winName) Deprecated. As of EP 7.1 Replaced by createRelativeNavigateClientCall(String, int, String[], NavigationParameters, NavigationSettings)
com.sapportals.portal.navigation.INavigationLink	createRelativeNavigateClientCall(String currentNode, int numOfLevelsUp, String[] atomicChildNodes, com.sapportals.portal.navigation.NavigationParameters navigationParameters, com.sapportals.portal.navigation.NavigationSettings navigationSettings) Creates a client call for relative navigation operation to the navigation target.

Field Detail

SHOW_INPLACE

static final int SHOW_INPLACE

A constant that defines the launch mode for launching in the same window.
0

See Also:

Constant Field Values

SHOW_EXTERNAL

static final int SHOW_EXTERNAL

A constant that defines the launch mode for launching in an external, new, standalone window.

See Also:

Constant Field Values

SHOW_EXTERNAL_PORTAL

static final int SHOW_EXTERNAL_PORTAL

A constant that defines the launch mode for launching in an external, new portal window.

See Also:

Constant Field Values

Method Detail

createAbsoluteNavigateClientCall

String createAbsoluteNavigateClientCall(String navTarget,
                                        int mode,
                                        String winFeatures,
                                        String winName)

Deprecated. As of EP 7.1 Replaced by createAbsoluteNavigateClientCall(String, NavigationParameters, NavigationSettings)

Creates a client call for Absolute navigate operation to the navigation target

Parameters:

navTarget - the navigation url to navigate to.

mode - the mode in which the navigation will be performed.

winFeatures - additional client windows properties (for exteranal window)

Returns:

client call for Absolute navigate operation to the navigation target

createAbsoluteNavigateClientCall

com.sapportals.portal.navigation.INavigationLink createAbsoluteNavigateClientCall(String navTarget,
                                                                                  com.sapportals.portal.navigation.NavigationParameters navigationParameters,
                                                                                  com.sapportals.portal.navigation.NavigationSettings navigationSettings)

Creates a client call for Absolute navigate operation to the navigation target

Parameters:

navTarget - the navigation url to navigate to.

navigationParameters - the parameters to pass to the target

navigationSettings - general sesstings for the navigation call

Returns:

navigation link

createRelativeNavigateClientCall

String createRelativeNavigateClientCall(String currentNode,
                                        int numOfLevelsUp,
                                        String[] atomicChildNodes,
                                        int mode,
                                        String winFeatures,
                                        String winName)

Deprecated. As of EP 7.1 Replaced by createRelativeNavigateClientCall(String, int, String[], NavigationParameters, NavigationSettings)

Creates a client call for relative navigation operation to the navigation target. For example: currentNode: "pcd:role1/folder1/folder2/folder3/workset1/page1" numOfLevelsUp: 3 atomicChildNodes: {"folder4", "workset2", "page2"}); should result the following URL (if the naming space is UNIX namespace) pcd:role1/folder1/folder2/folder4/workset2/page2

Parameters:

currentNode - the base node from which the navigation begins.

numOfLevelsUp - the number of levels to go up in the tree in order to pass to the children branch.

atomicChildNodes - the atomic names of the child nodes to navigate to.

mode - the mode in which the navigation will be performed.

winFeatures - additional client windows properties (for exteranal window).

Returns:

String represents the client call for Relative navigation operation.

createRelativeNavigateClientCall

com.sapportals.portal.navigation.INavigationLink createRelativeNavigateClientCall(String currentNode,
                                                                                  int numOfLevelsUp,
                                                                                  String[] atomicChildNodes,
                                                                                  com.sapportals.portal.navigation.NavigationParameters navigationParameters,
                                                                                  com.sapportals.portal.navigation.NavigationSettings navigationSettings)

Creates a client call for relative navigation operation to the navigation target. For example: currentNode: "pcd:role1/folder1/folder2/folder3/workset1/page1" numOfLevelsUp: 3 atomicChildNodes: {"folder4", "workset2", "page2"}); should result the following URL (if the naming space is UNIX namespace) pcd:role1/folder1/folder2/folder4/workset2/page2

Parameters:

currentNode - the base node from which the navigation begins.

numOfLevelsUp - the number of levels to go up in the tree in order to pass to the children branch.

atomicChildNodes - the atomic names of the child nodes to navigate to.

navigationParameters - the parameters to pass to the target

navigationSettings - general sesstings for the navigation call

Returns:

Navigation link

createObjectNavigateClientCall

String createObjectNavigateClientCall(String systemAlias,
                                      String businessObjName,
                                      String objValue,
                                      String operation)

Creates a client call for Object Based navigate operation.

Parameters:

systemAlias - the system alias that the object defined for.

businessObjName - the name of the object the navigation is request for.

objValue - the value of the object the navigation is request for.

operation - the operation the navigation is request for.

Returns:

client call for Object Based navigate opeartion.

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