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

Interface IF_BSP_PAGE

Übersicht

Das Interface IF_BSP_PAGE ermöglicht den Zugriff auf Informationen einer BSP wie z.B. den Seitennamen, die Lebensdauer, die zugehörige BSP-Applikation, die URL der Seite etc.

IF_BSP_PAGE wird durch die Klasse CL_BSP_PAGE implementiert, die die Basisklasse aller BSPs ist. Damit stehen die Methoden und Attribute dieses Interfaces in allen BSPs implizit über Vererbung zur Verfügung und können durch entsprechende Qualifizierung mit dem Interfacenamen (also z.B. "name = if_bsp_page~get_page_name( ).") zugegriffen werden.

Darüber hinaus ist dieses Interface in allen BSP-Eventhandlern über den Paramter page ansprechbar und kann somit auch in tieferliegende Applikationsschichten gereicht werden, falls dies notwendig sein sollte. Insbesondere können die Seitenattribute der BSP durch die Methoden get_attribute() und set_attribute() gelesen bzw. gesetzt werden.

Vererbungshierarchie/Interfacekomposition

Implementierende Klassen

CL_BSP_PAGE

Erweitertes Interface

Spezialisierte Interfaces

Attribute

Attributname	Deklarationsart	Beschreibung
co_format_currency	Konstante	write()- bzw. to_string()-Methode: Ausgabe als Währung
co_format_long	Konstante	write()- bzw. to_string()-Methode: lange Ausgabe
co_format_lower	Konstante	write()- bzw. to_string()-Methode: Ausgabe in Kleinbuchstaben
co_format_none	Konstante	write()- bzw. to_string()-Methode: Standardformatierung
co_format_short	Konstante	write()- bzw. to_string()-Methode: kurze Ausgabe
co_format_upper	Konstante	write()- bzw. to_string()-Methode: Ausgabe in Grossbuchstaben
lifetime_page	Konstante	Seite ist bis zu expliziter Navigation aus dieser Seite gültig
lifetime_request	Konstante	Seite ist nur für diesen HTTP-Request gültig
lifetime_session	Konstante	Seite ist für die gesamte Session gültig (nur bei stateful BSP-Applikationen)
messages	Instanzattribut	Referenz auf das messages-Objekt dieser BSP

Methoden

Methode get_application

Signatur	method get_application returning application type ref to object .
Beschreibung	Diese Methode liefert das Applikationsobjekt zu dieser BSP. Falls keine Applikationsklasse zur BSP-Applikation dieser Seite definiert wurde, wird eine Null-Referenz zurückgegeben.
Parameter	-
Return-Werte/ Exceptions	application Der Name der BSP-Applikation
Querreferenzen	Applikationsklasse einer BSP-Applikation

Methode get_application_name

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

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 (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/ Exceptions	start_page	Die Startseite der BSP-Applikation
Querreferenzen	-

Methode get_application_theme

Signatur	method get_application_theme returning theme type string .
Beschreibung	Diese Methode liefert den Namen des Themas der zugehörigen BSP-Applikation, wie es in der Entwicklungsumgebung (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.
Parameter	-
Return-Werte/ Exceptions	theme	Name des mit der BSP-Applikation assoziierten Themas.
Querreferenzen	Layout-Anpassungen an BSP-Applikationen

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, also z.B. /sap/bc/bsp/sap/retailstore.
Parameter	-
Return-Werte/ Exceptions	url	Server-lokale URL auf die aktuelle BSP-Applikation.
Querreferenzen	-

Methode get_attribute

Signatur	method get_attribute importing name type string exporting value type any .
Beschreibung	Diese Methode liefert den Wert des angegeforderten Attributes. Da Attribute beliebigen Typs sein können, kann der Rückgabewert value nur untypisiert sein und muss beim Aufruf typgerecht gebunden sein. Bei der Zuweisung des Attributwertes an den Rückgabewert kommt die ABAP move-Logik zum Tragen, so dass es zu Typkonvertierungen kommen kann. Gleichzeitig gelten die in ABAP vorhandenen Einschränkungen für Typkonvertierungen und es kann bei Typ-inkompatiblen Zuweisungen zu entsprechenden Ausnahmen kommen.
Parameter	name	Name des Attributes (case-insensitiv)
Return-Werte/ Exceptions	value		Wert des Attributes
	cx_bsp_inv_attr_name		Ausnahme: Attribut existiert nicht
Querreferenzen	set_attribute()

Methode get_lifetime

Signatur	method get_lifetime returning lifetime type i .
Beschreibung	Diese Methode liefert die aktuelle Einstellung der Lebensdauer dieser BSP (siehe lifetime_..-Konstanten des Interface IF_BSP_PAGE). Diese Methode hat bei stateless Applikationen keinen Effekt und liefert immer den Wert lifetime_request.
Parameter	-
Return-Werte/ Exceptions	lifetime	Aktuelle Lebensdauer der BSP siehe lifetime_..-Konstanten des Interface IF_BSP_PAGE): lifetime_page \| lifetime_request \| lifetime_session
Querreferenzen	set_lifetime, lifetime_page, lifetime_request, lifetime_session

Methode get_page_name

Signatur	method get_page_name returning name type string .
Beschreibung	Diese Methode liefert den Namen dieser BSP.
Parameter	-
Return-Werte/ Exceptions	name	Name der BSP
Querreferenzen	-

Methode get_page_url

Signatur	method get_page_url returning url type string .
Beschreibung	Diese Methode liefert die Server-lokale URL zu dieser BSP.
Parameter	-
Return-Werte/ Exceptions	url	Server-lokale URL der BSP
Querreferenzen	-

Methode get_request

Signatur	method get_request returning request type ref to if_http_request .
Beschreibung	Diese Methode liefert eine Interfacereferenz zum aktuellen HTTP-Request-Objekt.
Parameter	-
Return-Werte/ Exceptions	request	Interfacereferenz auf das HTTP-Request-Objekt
Querreferenzen	IF_HTTP_SERVER IF_HTTP_RESPONSE und IF_HTTP_REQUEST

Methode get_response

Signatur	method get_response returning response type ref to if_http_response .
Beschreibung	Diese Methode liefert eine Interfacereferenz zum aktuellen HTTP- Response -Objekt.
Parameter	-
Return-Werte/ Exceptions	response	Interfacereferenz auf das HTTP-Response-Objekt
Querreferenzen	IF_HTTP_SERVER IF_HTTP_RESPONSE und IF_HTTP_REQUEST

Methode get_runtime

Signatur	method get_runtime returning runtime type ref to if_bsp_runtime .
Beschreibung	Diese Methode liefert eine Interfacereferenz zum aktuellen BSP-Laufzeit-Objekt.
Parameter	-
Return-Werte/ Exceptions	runtime	Interfacereferenz auf das BSP-Laufzeit-Objekt
Querreferenzen	-

Methode serialize

Signatur	method serialize returning data type string .
Beschreibung	Diese Methode serialisiert den Inhalt dieser Seite (nach Durchlaufen des Layout-Eventhandlers) in einen String. Diese Methode wird typischerweise nur in der OnManipulation-Sektion der BSP aufgerufen werden, wenn der Bedarf besteht, die erzeugte Ausgabe nachzubearbeiten. Aus Performanzgründen ist hiervon allerdings abzuraten, wenn nicht zwingende funktionale Notwendigkeiten bestehen. Die Ausgabe einer BSP wird nicht mehr automatisch in der HTTP-Response an den Client zurückgeliefert, wenn diese Methode explizit gerufen wurde. Stattdessen ist der Entwickler in diesem Falle selbst für das Versenden zuständig. Dies kann über die Methode if_http_response~set_cdata() und das HTTP-Response-Objekt erfolgen.
Parameter	-
Return-Werte/ Exceptions	data	Serialisierte Antwort der BSP nach Durchlaufen der Layout-Sektion
Querreferenzen	IF_HTTP_SERVER IF_HTTP_RESPONSE und IF_HTTP_REQUEST

Methode set_attribute

Signatur	method set_attribute importing name type string value type any .
Beschreibung	Diese Methode setzt den Wert des angegebenen Attributes. Da Attribute beliebigen Typs sein können, kann der Parameter value nur untypisiert sein und muss beim Aufruf typgerecht gebunden sein. Diese Methode erlaubt nicht, zur Laufzeit dynamisch neue Attribute zu definieren. Vielmehr können nur Attribute, die in der Entwicklungsumgebung (SE80) statisch für die BSP definiert wurden, mit Werten belegt werden. Anderfalls erfolgt ein Abbruch mit der Exception cx_bsp_inv_attr_name. Bei der Zuweisung des Wertes an ein Attribut kommt die ABAP move-Logik zum Tragen, so dass es zu Typkonvertierungen kommen kann. Gleichzeitig gelten die in ABAP vorhandenen Einschränkungen für Typkonvertierungen und es kann bei Typ-inkompatiblen Zuweisungen zu entsprechenden Exceptions kommen.
Parameter	name	Name des Attributes (case-insensitiv)
Parameter	value	Wert des Attributes (geeignet typisiert)
Return-Werte/ Exceptions	cx_bsp_inv_attr_name	Ausnahme: Attribut existiert nicht
Querreferenzen	get_attribute()

Methode set_lifetime

Signatur	method set_lifetime importing lifetime type i .
Beschreibung	Diese Methode setzt die aktuelle Lebensdauer dieser BSP Seite (siehe lifetime_..-Konstanten des Interface IF_BSP_PAGE). Diese Methode hat bei stateless Applikationen keinen Effekt.
Parameter	lifetime	Neue Lebensdauer der BSP siehe lifetime_..-Konstanten des Interface IF_BSP_PAGE): lifetime_page \| lifetime_request \| lifetime_session
Return-Werte/ Exceptions	-
Querreferenzen	get_lifetime, lifetime_page, lifetime_request, lifetime_session

Methode to_string

Signatur	method to_string importing value type any format type i optional outputlength type i optional num_decimals type i optional reference_value type c returning string type string .
Beschreibung	Diese Methode bereitet den Wert einer skalaren, beliebig typisierten ABAP-Variablen als String auf, wobei über mehrere optionale Parameter die Formatierung gesteuert werden kann. Der so erzeugte String kann in einer BSP leicht über die Ausgabedirektive <%= .. %> in die Ausgabe eingestreut werden.
Parameter	value	Aufzubereitender Wert
	format	Ausgabeformat (siehe if_bsp_page~co_format_..-Konstanten)
	outputlength	Maximale Ausgabelänge (in Zeichen)
	num_decimals	Anzahl Dezimalstellen
	reference_value	Referenzwert (z.B. die Währung)
Return-Werte/ Exceptions	output	Aufbereiteter Ausgabestring
Querreferenzen	write()

Methode write

Signatur	method write importing value type any format type i optional outputlength type i optional num_decimals type i optional reference_value type c .
Beschreibung	Diese Methode gibt den Wert einer skalaren, beliebig typisierten ABAP-Variablen an der aktuellen "Schreibposition" in der BSP als String aus, wobei über mehrere optionale Parameter die Formatierung gesteuert werden kann. Diese Methode kann in einer BSP z.B. in Script-Direktiven <% .. %> zur Ausgabe verwendet werden.
Parameter	value	Aufzubereitender Wert
	format	Ausgabeformat (siehe if_bsp_page~co_format_..-Konstanten)
	outputlength	Maximale Ausgabelänge (in Zeichen)
	num_decimals	Anzahl Dezimalstellen
	reference_value	Referenzwert (z.B. die Währung)
Return-Werte/ Exceptions	-
Querreferenzen	to_string

Methode otr_trim

Signatur	method otr_trim importing alias returning text .
Beschreibung	Diese Methode liefert den sprachabhängigen Text zu einem OTR-Alias (Kurztext). Diese Methode steht ab SAP Web AS 6.20 Support Package 7 zur Verfügung.
Parameter	alias	Name des definierten OTR-Alias
Return-Werte/ Exceptions	text	Text in aktueller Sprache
Querreferenzen	Internationalisierung und Übersetzung