CL_BSP_NAVIGATION - Business Server Pages (BSP) Navigation

TXBHW - Original Tax Base Amount in Local Currency   Vendor Master (General Section)  
This documentation is copyright by SAP AG.

Functionality

The class CL_BSP_NAVIGATION provides methods for navigating between Business Server Pages

This gathers information that is important for the presentation of the subsequent page. Once the following page is navigated to, the navigation object is deleted.

The class contains methods that are required for defining the subsequent page, and methods that can be used for transferring parameters between the pages.

Methods for defining subsequent page

next_page

When this method is called, the following page is determined from the navigation structure. If, for example,

navigation->next_page( 'TOORDER' ).

is called, the navigation structure of the BSP application is searched for the navigation request TOORDER, and the corresponding page appears.

goto_page

When this method is called, the URL of the page that should appear next is entered directly, for example,

navigation->goto_page( 'error.htm' ).

exit

This method is used to terminate the current session of the application that is running and to go tothe page belonging to the URL specified. If no exit URL is specified, the application goes to the exit URL of the BSP application.

Example:

navigation->exit( exit_url = 'http://www.sap.com' ).

call_application

Use this method to go to a page (specified by URL) in another application. If the BSP application inwhich the method was called is running in stateful mode, the current context is retained. The new application receives the URL of the other application as a parameter.

Methods for transferring parameters to subsequent page

A page can transfer parameters to the subsequent page. The following methods are used for this purpose.

set_parameter

Use the call

navigation->set_parameter( name='myparameter' value = myvalue ).

to set the page parameter myparameter to the value myvalue. You can work with this value in the subsequent page.

If the form field (in the layout part) and the page parameters are of the type 'string', and are specified by the same name (in this case, myparameter), the abbreviation

navigation->set_parameter( 'myparameter' ).

can be used.

get_parameter

Use this method to get the value for a parameter. This method is not, however, recommended for BSP applications. It is used when a HTTP request handler is implemented.

has_parameters

This method returns 1 if at least one parameter was specified. Otherwise, the method returns 0.

Further information

You can find the documentation in the SAP Help Portal (http://help.sap.com/) under SAPNetWeaver → SAP Web Application Server. In the SAP Library, for SAP Web Application Server6.40, for example, choose path: SAP NetWeaver Components → Application Platform (SAP Web Application Server → ABAP Technology → UI Technology → Web UI Technology → Business Server Pages → Programming Model → Classes and Interfaces →Interface IF_BSP_NAVIGATION and in the documentation for the interface IF_BSP_NAVIGATION.


PERFORM Short Reference   CPI1466 during Backup  
This documentation is copyright by SAP AG.


Length: 3824 Date: 20120526 Time: 093358     triton ( 171 ms )