Interface IF_BSP_APPLICATION (SAP Library - Web Applications and Business Server Pages)

Interface IF_BSP_APPLICATION

Overview

The interface IF_BSP_APPLICATION is implemented using class CL_BSP_APPLICATION. It provides methods that enable a BSP application to call up information about its runtime environment or influence this environment.

Inheritance Hierarchy/Interface Composition

Implementing Classes

CL_BSP_APPLICATION

Enhanced Interface

Specializing Interfaces

Attributes

Methods

Method get_application_name

Signature	method get_application_name returning name type string .
Description	This method returns the name of the BSP application as defined in the development environment (transaction SE80).
Parameters	-
Return Values/Exceptions	NAME	Name of the BSP application

Method get_application_namespace

Signature	method get_application_namespace returning namespace type string .
Description	This method returns the name space of the corresponding BSP application as defined in the development environment (transaction SE80). For BSP applications that have no explicit name space specified, this is the SAP name space, in other words, the method returns "sap".
Parameters	-
Return Values/Exceptions	NAMESPACE	Name space of the BSP application

Method get_application_start_page

Signature	method get_application_start_page returning start_page type string .
Description	This method returns the start page of the corresponding BSP application as defined in the development environment (transaction SE80). If no page was explicitly specified, the method returns the name default.htm. The start page of a BSP application is called if no specific page is included in the URL when the application is started, in other words, when the URL ends with the application name.
Parameters	-
Return Values/Exceptions	START_PAGE	Start page of the BSP application

Method get_application_theme

Signature	method get_application_theme returning theme type string .
Description	This method returns the name of the theme of the BSP application as defined in the development environment (transaction SE80). If there is no theme explicitly associated with the BSP application, the method returns an empty string (default theme). Themes can be used together with BSP applications to customize the look and feel, see also Layout Adjustments to BSP Applications.
Parameters	-
Return Values/Exceptions	THEME	Name of the theme associated with the BSP application

Method get_application_url

Signature	method get_application_url returning url type string .
Description	This method returns a server-specific URL that references the current BSP application, for example /sap/bc/bsp/sap/retailstore.
Parameters	-
Return Values/Exceptions	URL	Server-specific URL of current BSP application

Method get_request

Signature	method get_request returning request type ref to if_http_request .
Description	This method returns an interface reference to the current HTTP request object.
Parameters	-
Return Values/Exceptions	REQUEST	Interface reference to the HTTP request object

Method get_response

Signature	method get_response returning request type ref to if_http_response .
Description	This method returns an interface reference to the current HTTP response object.
Parameters	-
Return Values/Exceptions	RESPONSE	Interface reference to the HTTP response object

Method get_runtime

Signature	method get_runtime returning runtime type ref to if_bsp_runtime .
Description	This method returns an interface reference to the current BSP runtime object.
Parameters	-
Return Values/Exceptions	RUNTIME	Interface reference to the BSP Runtime Object

Method get_timeout

Signature	method get_timeout returning timeout type t .
Description	This method returns the current timeout value (length of time). The timeout value is only important for stateful BSP applications. Stateful applications use this value to determine after what length of time the server should terminate a running application when no further requests are received. You can set timeout values in Transaction SICF for BSP applications, see also Creating an ICF Service.
Parameters	-
Return Values/Exceptions	TIMEOUT	Maximum length of time which a BSP application may continue to run in the absence of requests. After this time the application is automatically terminated.
Cross References	set_timeout

Method is_stateful

Signature	method is_stateful returning stateful type i .
Description	You can use this method to determine whether a BSP application is working stateful or stateless.
Parameters	-
Return Values/Exceptions	STATEFUL	0: Application is stateless 1: Application is stateful.
Cross References	See also: set_stateful, set_stateless

Method set_stateful

Signature	Method set_stateful
Description	This method sets the BSP application to stateful processing.
Parameters	-
Return Values/Exceptions	STATEFUL	0: Application is stateless 1: Application is stateful.
Cross References	See also: is_stateful, set_stateless

Method set_stateless

Signature	method set_stateless.
Description	This method sets the BSP application to stateless processing.
Parameters	-
Return Values/Exceptions	STATEFUL	0: Application is stateless 1: Application is stateful.
Cross References	See also: is_stateful, set_stateful

Method set_timeout

Signature	method set_timeout importing timeout type t .
Description	This method sets the current timeout value (length of time) of the BSP application. The timeout value is only important for stateful BSP applications. Stateful applications use this value to determine after what length of time the server should terminate a running application when no further requests are received. You can set timeout values in Transaction SICF for BSP applications, see also Creating an ICF Service.
Parameters	TIMEOUT	Maximum length of time which a BSP application may continue to run in the absence of requests. After this time the application is automatically terminated.
Return Values/Exceptions	-
Cross References	See also: get_timeout