Anfang des InhaltsbereichsObjektdokumentation Interface IF_BSP_RUNTIME Dokument im Navigationsbaum lokalisieren

Überblick

Das Interface IF_BSP_RUNTIME erlaubt den Zugriff auf Informationen aus der aktuellen Laufzeitumgebung einer BSP-Applikation. Die wichtigsten Objekte und Informationen sind als Attribute zugreifbar.

Hinweis

In die BSP-Laufzeit ist die Angabe der Accessibility integriert.

Vererbungshierarchie/Interfacekomposition

Implementierende Klasse

CL_BSP_RUNTIME

Attribute

Attributname

Deklarationsart

Beschreibung

application_name

Instanzattribut

Name der BSP-Applikation

application_namespace

Instanzattribut

Namensraum der BSP-Applikation

application_theme

Instanzattribut

Thema der BSP-Applikation

application_url

Instanzattribut

URL-Präfix der BSP-Applikation

ddic_utils

statisches Attribut

Dictionary-Dienste

keep_context

statisches Attribut

Stateful/stateless BSP-Applikation (0/1)

page_name

Instanzattribut

Name der BSP

page_url

Instanzattribut

URL-Präfix der BSP

runtime_url

statisches Attribut

URL-Präfix der BSP-Laufzeit

server

statisches Attribut

HTTP-Server

session_manager

statisches Attribut

Workplace Session Manager

client_info

statisches Attribut

Geräteeigenschaften für den aktuellen Request

session_id

statisches Attribut

BSP-Session-ID

Dieses Attribut kennzeichnet eindeutig die Benutzersitzung (Session). Dabei besteht völlige Backend-Unabhängigkeit, d.h. der Wert dieses Attributs wird unabhängig vom Kontext am Server belegt.
Der Wert dieses Attributs ändert sich nicht:

  • wenn Sie keep_context von 0 auf 1 setzen und
  • wenn Sie bei bereits geöffnetem Browser ein neues Fenster im Browser öffnen (z.B. über File ® New ® Window)

Dagegen ändert sich der Wert dieses Parameters, wenn Sie Ihren Browser schließen und wieder neu öffnen.

 

Methoden

Methode construct_bsp_url

Signatur

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
  .

Beschreibung

Diese Methode konstruiert eine Server-lokale, absolute URL zu einer BSP-Applikation oder BSP.

Über den Parameter in_protocol können Sie steuern, ob eine HTTP- oder HTTPS-URL generiert werden soll.

Achtung 

Diese Methode kann zur Laufzeit teuer sein (mehrere ms) und sollte daher nach Möglichkeit nicht unnötig häufig gerufen werden. Zur Laufzeit können Sie, anstatt diese statische Methode zu verwenden, auf die Instanzattribute runtime_url, application_url oder page_url ausweichen.

Parameter

in_protocol

Gewünschtes Protokoll (HTTP oder HTTPS)

in_host

Gewünschter Host

in_port

Gewünschte Portnummer

in_application_ns

Namensraum der BSP-Applikation (falls ungleich 'sap')

in_application

Name der BSP-Applikation

in_page

Name der BSP

in_parameters

Tabelle mit Name/Wert-Paaren, die als Query-String-Parameter in die URL eingemischt werden sollen

in_suppress_rewrite

0: URL-Rewriting der BSP-Laufzeit erlauben
1: URL-Rewriting der BSP-Laufzeit unterdrücken

Return-Werte/Ausnahmen

out_protocol

Tatsächliches Protokoll (HTTP oder HTTPS), das von in_protocol abweichen kann, wenn der Server dieses nicht unterstützt

out_host

Domain-Name des Applikationsservers

out_port

Portnummer zu Protokoll auf diesem Applikationsserver

out_local_url

URL relativ zum aktuellen Applikationsserver

out_abs_url

Absolute URL, d.h. einschließlich Protokoll, Applikationsservername, Portnummer etc.

 

Methode get_otr_text

Signatur

method get_otr_text
  importing
    alias type string
  returning
    text type string
  .

Beschreibung

Diese Methode liefert den OTR-Text in der aktuellen Sprache (sy-langu) zum gegebenen Alias.

Existiert der Alias nicht, wird ein Leerstring zurückgeliefert.

Existiert kein Text zum Alias in der aktuellen Sprache, wird die Sekundär- bzw. Fallback-Sprache verwendet.

Parameter

alias

OTR-Alias inklusive Namensraum (case-insensitiv)

Return-Werte/Ausnahmen

text

OTR-Text zum Alias in der aktuellen Sprache oder Leerstring, falls kein Alias existiert

 

Methode with_accessibility

Signatur

method with_accessibility
  returning
    access type boolean
  .

Beschreibung

Über diese Methode legen Sie die Accessibility fest.

Parameter

 

Return-Werte/Ausnahmen

access

Dieser Rückgabewert beihaltet die Angabe, ob die Accessibility aktiviert ist oder nicht.

Ende des Inhaltsbereichs