Interface IF_BSP_APPLICATION (SAP-Bibliothek - Web-Applikationen und Business Server Pages)

Interface IF_BSP_APPLICATION

Überblick

Das Interface IF_BSP_APPLICATION wird durch die Klasse CL_BSP_APPLICATION implementiert. Es stellt Methoden zur Verfügfung, über die eine BSP-Applikation Informationen über ihre Laufzeit-Umgebung abrufen bzw. über die sie diese beeinflussen kann.

Vererbungshierarchie/Interfacekomposition

Implementierende Klassen

CL_BSP_APPLICATION

Erweitertes Interface

Spezialisierende Interfaces

Attribute

Methoden

Methode get_application_name

Signatur	method get_application_name returning name type string .
Beschreibung	Diese Methode liefert den Namen der BSP-Applikation, wie er in der Entwicklungsumgebung (Transaktion SE80) definiert wurde..
Parameter	-
Return-Werte/Ausnahmen	NAME	Der Name der BSP-Applikation

Methode get_application_namespace

Signatur	method get_application_namespace returning namespace type string .
Beschreibung	Diese Methode liefern den Namensraum der zugehörigen BSP- Applikation, wie er in der Entwicklungsumgebung (Transaktion SE80) definiert wurde. Für BSP-Applikationen ohne explizite Namensraumangabe ist dies der SAP-Namensraum, d.h. es wird „sap" zurückgeliefert.
Parameter	-
Return-Werte/Ausnahmen	NAMESPACE	Der Namensraum der BSP-Applikation

Methode get_application_start_page

Signatur	method get_application_start_page returning start_page type string .
Beschreibung	Diese Methode liefert die Startseite der zugehörigen BSP-Applikation, wie sie in der Entwicklungsumgebung (Transaktion SE80) definiert wurde. Falls keine Seite explizit definiert wurde, liefert diese Methode den Namen default.htm. Die Startseite einer BSP-Applikation wird aufgerufen, wenn beim Anstarten der Applikation in der URL keine Seite explizit aufgeführt wurde, d.h. wenn die URL mit dem Namen der Applikation endet.
Parameter	-
Return-Werte/Ausnahmen	START_PAGE	Die Startseite der BSP-Applikation

Methode get_application_theme

Signatur	method get_application_theme returning theme type string .
Beschreibung	Diese Methode liefert den Namen des Themas der BSP-Applikation, wie es in der Entwicklungsumgebung (Transaktion SE80) definiert wurde. Ist kein Thema explizit mit der BSP-Applikation assoziiert worden, wird ein Leerstring geliefert (Default-Thema). Themen können in Verbindung mit BSP-Applikationen zum Customizing des Look & Feels eingesetzt werden, siehe auch Layout-Anpassungen an BSP-Applikationen.
Parameter	-
Return-Werte/Ausnahmen	THEME	Name des mit der BSP-Applikation assoziierten Themas

Methode get_application_url

Signatur	method get_application_url returning url type string .
Beschreibung	Diese Methode liefert eine Server-lokale URL, die auf die aktuelle BSP-Applikation verweist, z.B. /sap/bc/bsp/sap/retailstore.
Parameter	-
Return-Werte/Ausnahmen	URL	Server-lokale URL auf die aktuelle BSP-Applikation

Methode get_request

Signatur	method get_request returning request type ref to if_http_request .
Beschreibung	Diese Methode liefert eine Interface-Referenz zum aktuellen HTTP-Request-Objekt.
Parameter	-
Return-Werte/Ausnahmen	REQUEST	Interface-Referenz auf das HTTP-Request-Objekt

Methode get_response

Signatur	method get_response returning request type ref to if_http_response .
Beschreibung	Diese Methode liefert eine Interface-Referenz zum aktuellen HTTP-Response-Objekt.
Parameter	-
Return-Werte/Ausnahmen	RESPONSE	Interface-Referenz auf das BSP-Response-Objekt

Methode get_runtime

Signatur	method get_runtime returning runtime type ref to if_bsp_runtime .
Beschreibung	Diese Methode liefert eine Interface-Referenz zum aktuellen BSP-Laufzeit-Objekt.
Parameter	-
Return-Werte/Ausnahmen	RUNTIME	Interface-Referenz auf das BSP-Laufzeit-Objekt

Methode get_timeout

Signatur	method get_timeout returning timeout type t .
Beschreibung	Diese Methode liefert den aktuellen Timeout-Wert (Zeitspanne). Der Timeout-Wert hat nur für stateful BSP-Applikationen eine Bedeutung. Durch ihn wird bei diesen gesteuert, nach welcher Zeitspanne der Server eine laufende Applikation automatisch beenden soll, wenn keine weiteren Requests mehr eintreffen. Sie können Timeout-Werte in der Transaktion SICF für BSP-Applikationen einstellen, siehe auch Anlegen eines ICF-Services.
Parameter	-
Return-Werte/Ausnahmen	TIMEOUT	Maximale Zeitspanne des Ausbleibens von Requests für eine laufende BSP-Applikation, ehe diese automatisch beendet wird.
Querreferenzen	set_timeout

Methode is_stateful

Signatur	method is_stateful returning stateful type i .
Beschreibung	Sie können diese Methode verwenden, um zu ermitteln, ob eine BSP-Applikation stateful oder stateless arbeitet.
Parameter	-
Return-Werte/Ausnahmen	STATEFUL	0: Applikation ist stateless 1: Applikation ist stateful.
Querreferenzen	Siehe auch: set_stateful, set_stateless

Methode set_stateful

Signatur	method set_stateful.
Beschreibung	Diese Methode versetzt die BSP-Applikation in stateful Bearbeitung.
Parameter	-
Return-Werte/Ausnahmen	STATEFUL	0: Applikation ist stateless 1: Applikation ist stateful.
Querreferenzen	Siehe auch: is_stateful, set_stateless

Methode set_stateless

Signatur	method set_stateless.
Beschreibung	Diese Methode versetzt die BSP-Applikation in stateless Bearbeitung.
Parameter	-
Return-Werte/Ausnahmen	STATEFUL	0: Applikation ist stateless 1: Applikation ist stateful.
Querreferenzen	Siehe auch: is_stateful, set_stateful

Methode set_timeout

Signatur	method set_timeout importing timeout type t .
Beschreibung	Diese Methode setzt den aktuellen Timeout-Wert (Zeitspanne) der BSP-Applikation. Der Timeout-Wert hat nur für statefull BSP-Applikationen eine Bedeutung. Durch ihn wird bei diesen gesteuert, nach welcher Zeitspanne der Server eine laufende Applikation automatisch beenden soll, wenn keine weiteren Requests mehr eintreffen. Sie können Timeout-Werte in der Transaktion SICF für BSP-Applikationen einstellen, siehe auch Anlegen eines ICF-Services.
Parameter	TIMEOUT	Maximale Zeitspanne des Ausbleibens von Requests für eine laufende BSP-Applikation, ehe diese automatisch beendet wird.
Return-Werte/Ausnahmen	-
Querreferenzen	Siehe auch: get_timeout