com.sap.tc.webdynpro.clientserver.navigation.api
Class WDPortalNavigation

java.lang.Object
  |
  +--com.sap.tc.webdynpro.clientserver.navigation.api.WDPortalNavigation

public class WDPortalNavigation

extends java.lang.Object

WDPortalNavigation provides access to portal navigation functionality.

Inner Class Summary

static interface

WDPortalNavigation.IWDPortalNavigation

Field Summary

static java.lang.String	OBN_BO_TYPE Defines the name of the parameter containing the business object type.
static java.lang.String	OBN_OPERATION Defines the name of the parameter containing the triggered operation.
static java.lang.String	OBN_SYSTEM Defines the name of the parameter containing the system of the business object.

Method Summary

static void	navigateAbsolute(java.lang.String navigationTarget, WDPortalNavigationMode mode, java.lang.String windowFeatures, java.lang.String windowName, java.lang.String businessParameters) Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. Use one of the similar methods in this class that accept a parameter of type WDPortalNavigationHistoryMode to define the needed history mode.
static void	navigateAbsolute(java.lang.String navigationTarget, WDPortalNavigationMode mode, java.lang.String windowFeatures, java.lang.String windowName, java.lang.String businessParameters, boolean useSAPLauncher) Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. Use one of the similar methods in this class that accept a parameter of type WDPortalNavigationHistoryMode to define the needed history mode.
static void	navigateAbsolute(java.lang.String navigationTarget, WDPortalNavigationMode mode, java.lang.String windowFeatures, java.lang.String windowName, WDPortalNavigationHistoryMode historyMode, java.lang.String targetTitle, java.lang.String contextUrl, java.lang.String businessParameters) Performs a navigation to a absolute defined navigation target.
static void	navigateAbsolute(java.lang.String navigationTarget, WDPortalNavigationMode mode, java.lang.String windowFeatures, java.lang.String windowName, WDPortalNavigationHistoryMode historyMode, java.lang.String targetTitle, java.lang.String contextUrl, java.lang.String businessParameters, boolean useSAPLauncher) Performs a navigation to a absolute defined navigation target.
static void	navigateAbsolute(java.lang.String navigationTarget, WDPortalNavigationMode mode, java.lang.String windowFeatures, java.lang.String windowName, WDPortalNavigationHistoryMode historyMode, java.lang.String targetTitle, java.lang.String contextUrl, java.lang.String businessParameters, java.lang.String launcherParameters, boolean postParameters, boolean useSAPLauncher) Performs a navigation to a absolute defined navigation target.
static void	navigateAbsolute(java.lang.String navigationTarget, WDPortalNavigationMode mode, WDPortalNavigationHistoryMode historyMode, java.lang.String businessParameters) Performs a navigation to a absolute defined navigation target.
static void	navigateRelative(java.lang.String baseUrl, int levelsUp, java.lang.String[] path, java.lang.String navigationTarget, WDPortalNavigationMode mode, java.lang.String windowFeatures, java.lang.String windowName, WDPortalNavigationHistoryMode historyMode, java.lang.String targetTitle, java.lang.String contextUrl, java.lang.String businessParameters) Performs a navigation to a relative defined navigation target.
static void	navigateRelative(java.lang.String baseUrl, int levelsUp, java.lang.String[] path, WDPortalNavigationMode mode, java.lang.String windowFeatures, java.lang.String windowName, WDPortalNavigationHistoryMode historyMode, java.lang.String targetTitle, java.lang.String contextUrl, java.lang.String businessParameters, boolean useSAPLauncher) Performs a navigation to a relative defined navigation target.
static void	navigateRelative(java.lang.String baseUrl, int levelsUp, java.lang.String[] path, WDPortalNavigationMode mode, java.lang.String windowFeatures, java.lang.String windowName, WDPortalNavigationHistoryMode historyMode, java.lang.String targetTitle, java.lang.String contextUrl, java.lang.String businessParameters, java.lang.String launcherParameters, boolean postParameters, boolean useSAPLauncher) Performs a navigation to a relative defined navigation target.
static void	navigateRelative(java.lang.String baseUrl, int levelsUp, java.lang.String[] path, WDPortalNavigationMode mode, WDPortalNavigationHistoryMode historyMode, java.lang.String businessParameters) Performs a navigation to a relative defined navigation target.
static void	navigateToObject(java.lang.String system, java.lang.String businessobjType, java.lang.String objValue, java.lang.String businessParameters) Performs a navigation to the default operation of the defined businees object.
static void	navigateToObject(java.lang.String system, java.lang.String businessobjType, java.lang.String objValue, java.lang.String businessParameters, boolean useSAPLauncher) Deprecated. Do not use this method any longer, it may be withdrawn with the first new NetWeaver release in 2006. Use navigateToObject without parameter useSAPLauncher instead.
static void	navigateToObject(java.lang.String system, java.lang.String businessobjType, java.lang.String objValue, java.lang.String objValueName, java.lang.String businessParameters, boolean forwardOBNMetaData) Performs a navigation to the default operation of the defined businees object.
static void	navigateToObjectWithSpecificOperation(java.lang.String system, java.lang.String businessobjType, java.lang.String objValue, java.lang.String operation, java.lang.String businessParameters) Performs a navigation to the specified operation of the defined businees object.
static void	navigateToObjectWithSpecificOperation(java.lang.String system, java.lang.String businessobjType, java.lang.String objValue, java.lang.String objValueName, java.lang.String operation, java.lang.String businessParameters, boolean forwardOBNMetaData) Performs a navigation to the specific operation of the defined businees object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OBN_SYSTEM

public static final java.lang.String OBN_SYSTEM

Defines the name of the parameter containing the system of the business object.

OBN_BO_TYPE

public static final java.lang.String OBN_BO_TYPE

Defines the name of the parameter containing the business object type.

OBN_OPERATION

public static final java.lang.String OBN_OPERATION

Defines the name of the parameter containing the triggered operation.

Method Detail

navigateAbsolute

public static void navigateAbsolute(java.lang.String navigationTarget,
                                    WDPortalNavigationMode mode,
                                    java.lang.String windowFeatures,
                                    java.lang.String windowName,
                                    WDPortalNavigationHistoryMode historyMode,
                                    java.lang.String targetTitle,
                                    java.lang.String contextUrl,
                                    java.lang.String businessParameters,
                                    java.lang.String launcherParameters,
                                    boolean postParameters,
                                    boolean useSAPLauncher)

Performs a navigation to a absolute defined navigation target.

Parameters:

navigationTarget - the absolute navigation url to navigate to

mode - the mode in which the navigation will be performed

windowFeatures - additional client windows properties (for external window only)

windowName - the name of the client window (for external window only)

historyMode - the used history mode (i.e. defined how the navigation target occurs in the navigation history)

targetTitle - the displayed title in the page titel bar (optional)

contextUrl - the used navigation context (optional)

businessParameters - optional (business) parameters like customerID=4711

launcherParameters - optional (launcher) parameters like WebDynproNamespace=myNamespace

postParameters - defines whether or not the defined parameters are POST or GET parameters

useSAPLauncher - should be TRUE if the navigation destination uses the SAP application launcher (i.e. if the navigation destination is implemented using BSP, Web Dynpro, ITS or SAPGui).

navigateAbsolute

public static void navigateAbsolute(java.lang.String navigationTarget,
                                    WDPortalNavigationMode mode,
                                    java.lang.String windowFeatures,
                                    java.lang.String windowName,
                                    WDPortalNavigationHistoryMode historyMode,
                                    java.lang.String targetTitle,
                                    java.lang.String contextUrl,
                                    java.lang.String businessParameters,
                                    boolean useSAPLauncher)

Performs a navigation to a absolute defined navigation target. All defined parameters are handled as GET parameters.

Parameters:

navigationTarget - the absolute navigation url to navigate to

mode - the mode in which the navigation will be performed

windowFeatures - additional client windows properties (for external window only)

windowName - the name of the client window (for external window only)

historyMode - the used history mode (i.e. defined how the navigation target occurs in the navigation history)

targetTitle - the displayed title in the page titel bar (optional)

contextUrl - the used navigation context (optional)

businessParameters - optional (business) parameters like customerID=4711

useSAPLauncher - should be TRUE if the navigation destination uses the SAP application launcher (i.e. if the navigation destination is implemented using BSP, Web Dynpro, ITS or SAPGui).

navigateAbsolute

public static void navigateAbsolute(java.lang.String navigationTarget,
                                    WDPortalNavigationMode mode,
                                    java.lang.String windowFeatures,
                                    java.lang.String windowName,
                                    WDPortalNavigationHistoryMode historyMode,
                                    java.lang.String targetTitle,
                                    java.lang.String contextUrl,
                                    java.lang.String businessParameters)

Performs a navigation to a absolute defined navigation target. The assumption is that this navigation target uses the SAP application launcher. All defined parameters are handled as GET parameters.

Parameters:

navigationTarget - the absolute navigation url to navigate to

mode - the mode in which the navigation will be performed

windowFeatures - additional client windows properties (for external window only)

windowName - the name of the client window (for external window only)

historyMode - the used history mode (i.e. defined how the navigation target occurs in the navigation history)

targetTitle - the displayed title in the page titel bar (optional)

contextUrl - the used navigation context (optional)

businessParameters - optional (business) parameters like customerID=4711

navigateAbsolute

public static void navigateAbsolute(java.lang.String navigationTarget,
                                    WDPortalNavigationMode mode,
                                    java.lang.String windowFeatures,
                                    java.lang.String windowName,
                                    java.lang.String businessParameters)

Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. Use one of the similar methods in this class that accept a parameter of type WDPortalNavigationHistoryMode to define the needed history mode.

Performs a navigation to a absolute defined navigation target. The assumption is that this navigation target uses the SAP application launcher. All defined parameters are handled as GET parameters.

Parameters:

navigationTarget - the absolute navigation url to navigate to

mode - the mode in which the navigation will be performed

windowFeatures - additional client windows properties (for external window only)

windowName - the name of the client window (for external window only)

businessParameters - optional (business) parameters like customerID=4711

navigateAbsolute

public static void navigateAbsolute(java.lang.String navigationTarget,
                                    WDPortalNavigationMode mode,
                                    java.lang.String windowFeatures,
                                    java.lang.String windowName,
                                    java.lang.String businessParameters,
                                    boolean useSAPLauncher)

Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. Use one of the similar methods in this class that accept a parameter of type WDPortalNavigationHistoryMode to define the needed history mode.

Performs a navigation to a absolute defined navigation target. The assumption is that this navigation target uses the SAP application launcher. All defined parameters are handled as GET parameters.

Parameters:

navigationTarget - the absolute navigation url to navigate to

mode - the mode in which the navigation will be performed

windowFeatures - additional client windows properties (for external window only)

windowName - the name of the client window (for external window only)

businessParameters - optional (business) parameters like customerID=4711

useSAPLauncher - should be TRUE if the navigation destination uses the SAP application launcher (i.e. if the navigation destination is implemented using BSP, Web Dynpro, ITS or SAPGui).

navigateAbsolute

public static void navigateAbsolute(java.lang.String navigationTarget,
                                    WDPortalNavigationMode mode,
                                    WDPortalNavigationHistoryMode historyMode,
                                    java.lang.String businessParameters)

Performs a navigation to a absolute defined navigation target. The assumption is that this navigation target uses the SAP application launcher. All defined parameters are handled as GET parameters.

Parameters:

navigationTarget - the absolute navigation url to navigate to

mode - the mode in which the navigation will be performed

historyMode - the used history mode (i.e. defined how the navigation target occurs in the navigation history)

businessParameters - optional (business) parameters like customerID=4711

navigateRelative

public static void navigateRelative(java.lang.String baseUrl,
                                    int levelsUp,
                                    java.lang.String[] path,
                                    WDPortalNavigationMode mode,
                                    java.lang.String windowFeatures,
                                    java.lang.String windowName,
                                    WDPortalNavigationHistoryMode historyMode,
                                    java.lang.String targetTitle,
                                    java.lang.String contextUrl,
                                    java.lang.String businessParameters,
                                    java.lang.String launcherParameters,
                                    boolean postParameters,
                                    boolean useSAPLauncher)

Performs a navigation to a relative defined navigation target.

Parameters:

baseUrl - the base url (i.e. the start point for the relative navigation). Could be NULL - in this case the start url is computed automatically (the current position of the navigation trigger is used).

levelsUp - the number of levels up

path - a list of the children to navigate to

mode - the mode in which the navigation will be performed

windowFeatures - additional client windows properties (for external window only)

windowName - the name of the client window (for external window only)

historyMode - the used history mode (i.e. defined how the navigation target occurs in the navigation history)

targetTitle - the displayed title in the page titel bar (optional)

contextUrl - the used navigation context (optional)

businessParameters - optional (business) parameters like customerID=4711

launcherParameters - optional (launcher) parameters like WebDynproNamespace=myNamespace

postParameters - defines whether or not the defined parameters are POST or GET parameters

useSAPLauncher - should be TRUE if the navigation destination uses the SAP application launcher (i.e. if the navigation destination is implemented using BSP, Web Dynpro, ITS or SAPGui).

navigateRelative

public static void navigateRelative(java.lang.String baseUrl,
                                    int levelsUp,
                                    java.lang.String[] path,
                                    WDPortalNavigationMode mode,
                                    java.lang.String windowFeatures,
                                    java.lang.String windowName,
                                    WDPortalNavigationHistoryMode historyMode,
                                    java.lang.String targetTitle,
                                    java.lang.String contextUrl,
                                    java.lang.String businessParameters,
                                    boolean useSAPLauncher)

Performs a navigation to a relative defined navigation target.

Parameters:

baseUrl - the base url (i.e. the start point for the relative navigation). Could be NULL - in this case the start url is computed automatically (the current position of the navigation trigger is used).

levelsUp - the number of levels up

path - a list of the children to navigate to

mode - the mode in which the navigation will be performed

windowFeatures - additional client windows properties (for external window only)

windowName - the name of the client window (for external window only)

historyMode - the used history mode (i.e. defined how the navigation target occurs in the navigation history)

targetTitle - the displayed title in the page titel bar (optional)

contextUrl - the used navigation context (optional)

businessParameters - optional (business) parameters like customerID=4711

useSAPLauncher - should be TRUE if the navigation destination uses the SAP application launcher (i.e. if the navigation destination is implemented using BSP, Web Dynpro, ITS or SAPGui).

navigateRelative

public static void navigateRelative(java.lang.String baseUrl,
                                    int levelsUp,
                                    java.lang.String[] path,
                                    java.lang.String navigationTarget,
                                    WDPortalNavigationMode mode,
                                    java.lang.String windowFeatures,
                                    java.lang.String windowName,
                                    WDPortalNavigationHistoryMode historyMode,
                                    java.lang.String targetTitle,
                                    java.lang.String contextUrl,
                                    java.lang.String businessParameters)

Performs a navigation to a relative defined navigation target. The assumption is that this navigation target uses the SAP application launcher.

Parameters:

baseUrl - the base url (i.e. the start point for the relative navigation). Could be NULL - in this case the start url is computed automatically (the current position of the navigation trigger is used).

levelsUp - the number of levels up

path - a list of the children to navigate to

mode - the mode in which the navigation will be performed

windowFeatures - additional client windows properties (for external window)

windowName - the name of the client window (for external window)

historyMode - the used history mode (i.e. defined how the navigation target occurs in the navigation history)

targetTitle - the displayed title in the page titel bar (optional)

contextUrl - the used navigation context (optional)

businessParameters - optional (business) parameters like customerID=4711

navigateRelative

public static void navigateRelative(java.lang.String baseUrl,
                                    int levelsUp,
                                    java.lang.String[] path,
                                    WDPortalNavigationMode mode,
                                    WDPortalNavigationHistoryMode historyMode,
                                    java.lang.String businessParameters)

Performs a navigation to a relative defined navigation target. The assumption is that this navigation target uses the SAP application launcher.

Parameters:

baseUrl - the base url (i.e. the start point for the relative navigation). Could be NULL - in this case the start url is computed automatically (the current position of the navigation trigger is used).

levelsUp - the number of levels up

path - a list of the children to navigate to

mode - the mode in which the navigation will be performed

historyMode - the used history mode (i.e. defined how the navigation target occurs in the navigation history)

businessParameters - optional (business) parameters like customerID=4711

navigateToObject

public static void navigateToObject(java.lang.String system,
                                    java.lang.String businessobjType,
                                    java.lang.String objValue,
                                    java.lang.String businessParameters,
                                    boolean useSAPLauncher)

Deprecated. Do not use this method any longer, it may be withdrawn with the first new NetWeaver release in 2006. Use navigateToObject without parameter useSAPLauncher instead.

Performs a navigation to the default operation of the defined businees object.

Parameters:

system - the system which defines the business object

businessobjectType - the business object type

objValue - the businees object value

businessParameters - optional (business) parameters like customerID=4711

useSAPLauncher - should be TRUE if the navigation destination uses the SAP application launcher (i.e. if the navigation destination is implemented using BSP, Web Dynpro, ITS or SAPGui).

navigateToObject

public static void navigateToObject(java.lang.String system,
                                    java.lang.String businessobjType,
                                    java.lang.String objValue,
                                    java.lang.String businessParameters)

Performs a navigation to the default operation of the defined businees object.

Parameters:

system - the system which defines the business object

businessobjectType - the business object type

objValue - the business object value

businessParameters - optional (business) parameters like customerID=4711

navigateToObject

public static void navigateToObject(java.lang.String system,
                                    java.lang.String businessobjType,
                                    java.lang.String objValue,
                                    java.lang.String objValueName,
                                    java.lang.String businessParameters,
                                    boolean forwardOBNMetaData)

Performs a navigation to the default operation of the defined businees object.

Parameters:

system - the system which defines the business object

businessobjectType - the business object type

objValue - the business object value

objValueName - the used name for the object value

businessParameters - optional (business) parameters like customerID=4711 #

forwardOBNMetaData - should be TRUE if the meta data of the OBN should be also forwarded.

navigateToObjectWithSpecificOperation

public static void navigateToObjectWithSpecificOperation(java.lang.String system,
                                                         java.lang.String businessobjType,
                                                         java.lang.String objValue,
                                                         java.lang.String operation,
                                                         java.lang.String businessParameters)

Performs a navigation to the specified operation of the defined businees object.

Parameters:

system - the system which defines the business object

businessobjectType - the business object type

objValue - the business object value

operation - the operation

businessParameters - optional (business) parameters like customerID=4711

navigateToObjectWithSpecificOperation

public static void navigateToObjectWithSpecificOperation(java.lang.String system,
                                                         java.lang.String businessobjType,
                                                         java.lang.String objValue,
                                                         java.lang.String objValueName,
                                                         java.lang.String operation,
                                                         java.lang.String businessParameters,
                                                         boolean forwardOBNMetaData)

Performs a navigation to the specific operation of the defined businees object.

Parameters:

system - the system which defines the business object

businessobjectType - the business object type

objValue - the business object value

objValueName - the used name for the object value

operation - the operation

businessParameters - optional (business) parameters like customerID=4711

forwardOBNMetaData - should be TRUE if the meta data of the OBN should be also forwarded.