Show TOC

Object navigationLocate this document in the navigation structure

Definition

The object navigation has the same type as interface IF_BSP_NAVIGATION.

The following methods are available for navigation between BSP pages. They collect information required for the presentation of the subsequent page. After the subsequent is navigated to, the navigation object is deleted.

The class contains methods which are used to determine the characteristics of the subsequent page, and methods which can be used for transferring parameters between pages.

Methods for Constructing the Subsequent Page

next_page

When called, this method determines the subsequent page from the navigation structure.

This call triggers a search for the navigation request TOORDER in the navigation structure of the BSP application, and the subsequent page is opened.

            
navigation->next_page( 'TOORDER' ).

goto_page

When this method is called, the URL of the page that is to be navigated to next is displayed.

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

exit

This method ends the current session in the active application and navigates to the given URL. If no exit URL is given, the exit URL of the BSP application is used.

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

call_application

You can use this method to navigate to a page (specified by the URL) in another application.

If the BSP application in which the method was called is running in stateful mode, the current context is maintained. The new application receives the URL of the other application as a parameter.

Methods for Transferring Parameters to the Subsequent Page

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

set_parameter

Using the call

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

You can set the page parameter myparameter to the value myvalue. This value can then be used for processing in the subsequent page.

If the form field (in the layout part) and the page parameter are of the type string and are specified by the same name (in this case, myparameter), the following abbreviation can be used:

navigation->set_parameter( 'myparameter' ).

get_parameter

Use this method to get the value for a parameter.

Note

This method is not recommended for BSP applications. It is used when the user's own HTTP request handlers are implemented.

has_parameters

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