com.sapportals.portal.navigation

Interface INavigationGenerator

All Superinterfaces:
IClientNavigationGenerator

public interface INavigationGenerator
extends IClientNavigationGenerator

The interface that creates client calls for navigation operations. The client calls are the JavaScript code (doNavigate() method) for performing object-based navigation.


Field Summary
 
Fields inherited from interface com.sapportals.portal.navigation.IClientNavigationGenerator
SHOW_EXTERNAL, SHOW_EXTERNAL_PORTAL, SHOW_INPLACE
 
Method Summary
 String getPortalURL(IPortalComponentRequest request, String navTarget)
          Gets a URL for navigating to a navigation target displayed within the framework page.
 String getRelativePortalURL(IPortalComponentRequest request, String NavigationTarget)
          Gets a Relative URL for navigating to a navigation target displayed within the framework page.
 
Methods inherited from interface com.sapportals.portal.navigation.IClientNavigationGenerator
createAbsoluteNavigateClientCall, createAbsoluteNavigateClientCall, createObjectNavigateClientCall, createRelativeNavigateClientCall, createRelativeNavigateClientCall
 

Method Detail

getPortalURL

String getPortalURL(IPortalComponentRequest request,
                    String navTarget)
Gets a URL for navigating to a navigation target displayed within the framework page.

The URL is the standard portal URL, up to and including the alias, plus the NavigationTarget parameter.

For example, http://<server>:<port>/irj/portal?NavigationTarget=<pcd address>

Parameters:
request - a portal request
navTarget - the target URL
Returns:
the URL

getRelativePortalURL

String getRelativePortalURL(IPortalComponentRequest request,
                            String NavigationTarget)
Gets a Relative URL for navigating to a navigation target displayed within the framework page. For example, NavigationTarget=<pcd address>

Parameters:
request - a portal request
NavigationTarget - the target URL
Returns:
the URL
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


Copyright 2011 SAP AG Complete Copyright Notice