com.sapportals.portal.navigation
Interface IClientNavigationGenerator

All Known Subinterfaces:

INavigationGenerator

public interface IClientNavigationGenerator

Title: Navigation Client Generator Description: Creates client calls for Navigation Copyright: Copyright (c) 2002 Company: SAP

Version:

1.0

Field Summary

static int	SHOW_EXTERNAL Parameter defining the launching of the navigation node will be performed in an external (new) STANDALONE window.
static int	SHOW_EXTERNAL_PORTAL Parameter defining the launching of the navigation node will be performed in an external (new) PORTAL window.
static int	SHOW_INPLACE Parameter defining the launching of the navigation node will be performed in the same window.

Method Summary

java.lang.String	createAbsoluteNavigateClientCall(java.lang.String navTarget, int mode, java.lang.String winFeatures, java.lang.String winName) Creates a client call for Absolute navigate operation to the navigation target
java.lang.String	createObjectNavigateClientCall(java.lang.String systemAlias, java.lang.String businessObjName, java.lang.String objValue, java.lang.String operation) Creates a client call for Object Based navigate operation.
java.lang.String	createRelativeNavigateClientCall(java.lang.String currentNode, int numOfLevelsUp, java.lang.String[] atomicChildNodes, int mode, java.lang.String winFeatures, java.lang.String winName) Creates a client call for relative navigation operation to the navigation target.

Field Detail

SHOW_INPLACE

public static final int SHOW_INPLACE

Parameter defining the launching of the navigation node will be performed in the same window.

SHOW_EXTERNAL

public static final int SHOW_EXTERNAL

Parameter defining the launching of the navigation node will be performed in an external (new) STANDALONE window.

SHOW_EXTERNAL_PORTAL

public static final int SHOW_EXTERNAL_PORTAL

Parameter defining the launching of the navigation node will be performed in an external (new) PORTAL window.

Method Detail

createAbsoluteNavigateClientCall

public java.lang.String createAbsoluteNavigateClientCall(java.lang.String navTarget,
                                                         int mode,
                                                         java.lang.String winFeatures,
                                                         java.lang.String winName)

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

createRelativeNavigateClientCall

public java.lang.String createRelativeNavigateClientCall(java.lang.String currentNode,
                                                         int numOfLevelsUp,
                                                         java.lang.String[] atomicChildNodes,
                                                         int mode,
                                                         java.lang.String winFeatures,
                                                         java.lang.String winName)

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.

createObjectNavigateClientCall

public java.lang.String createObjectNavigateClientCall(java.lang.String systemAlias,
                                                       java.lang.String businessObjName,
                                                       java.lang.String objValue,
                                                       java.lang.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.