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

Interface IF_BSP_RUNTIME

Overview

The interface IF_BSP_RUNTIME gives you access to information contained in the current runtime environment of a BSP application. It gives you access to the most important objects and information in the form of attributes.

Note

Accessibility is integrated in the BSP runtime.

Inheritance Hierarchy/Interface Composition

Implementing Class

CL_BSP_RUNTIME

Attributes

Attribute Name	Declaration Type	Description
application_name	Instance attribute	Name of BSP application
application_namespace	Instance attribute	Name space of BSP application
application_theme	Instance attribute	Theme of BSP application
application_url	Instance attribute	URL prefix of BSP application
ddic_utils	Static attribute	Dictionary services
keep_context	Static attribute	Stateful/stateless BSP application (0/1)
page_name	Instance attribute	Name of the BSP
page_url	Instance attribute	URL prefix of BSP
runtime_url	Static attribute	URL prefix of BSP runtime
server	Static attribute	HTTP Server
session_manager	Static attribute	Workplace Session Manager
client_info	Static attribute	Device properties for the current request
session_id	Static attribute	BSP Session ID This attribute uniquely labels the user session. The backend is therefore completely independent, that is, the value of this attribute is set independently of the context at the server. The value of this attribute does not change: If you set keep_context from 0 to 1 and If you already have a browser open and you open a new one (using File ® New ® Window, for example) The value of this parameter does change if you close the browser and open a new one.

Methods

Method construct_bsp_url

Signature	class-method construct_bsp_url importing in_protocol type string default 'http' in_host type string optional in_port type string optional in_application_ns type string optional in_application type string in_page type string optional in_parameters type tihttpnvp optional in_suppress_rewrite type I default 0 exporting out_protocol type string out_host type string out_port type string out_local_url type string out_abs_url type string .
Description	This method builds a server-specific, absolute URL for a BSP application or BSP. You can use the parameter in_protocol to control whether a HTTP- or HTTPS URL should be generated. This method can be expensive at runtime, You are recommended not to call it unnecessarily often. At runtime, instead of using this static method, you can use the instance attribute runtime_url, application_url or page_url as an alternative.
Parameters	in_protocol	Requested protocol (HTTP or HTTPS)
	in_host	Requested Host
	in_port	Requested Port Number
	in_application_ns	Namespace of the BSP application (if not 'sap')
	in_application	Name of BSP application
	in_page	Name of the BSP
	in_parameters	Table with name/value pairs that are to be integrated in the URL as query-string parameters
	in_suppress_rewrite	0: Allow URL rewriting of the BSP runtime 1: Suppress URL rewriting of the BSP runtime
Return Values/Exceptions	out_protocol	Actual protocol (HTTP or HTTPS), which can differ from in_protocol if not supported by the server
	out_host	Domain name of the application server
	out_port	Port number of protocol on the application server
	out_local_url	URL relative to current application server
	out_abs_url	Absolute URL, that is, including protocol, application server name, port number etc.

Method get_otr_text

Signature	method get_otr_text importing alias type string returning text type string .
Description	This method returns the OTR text in the current langauge (sy-langu) for the alias specified. If there is no such alias, an empty string is returned. If there is no text for the alias in the current language, the secondary (or fallback) language is used.
Parameters	alias	OTR alias including name space (case-insensitive)
Return Values/Exceptions	text	OTR text for alias in the current language or empty string if no alias exists

Method with_accessibility

Signature	method with_accessibility returning access type boolean .
Description	You determine the accessibility using this method.
Parameters
Return Values/Exceptions	access	This return value states whether accessibility is active or not.