Klasse CL_BSP_MESSAGES

Verwendung

Die Klasse CL_BSP_MESSAGES können Sie in BSPs zur Ausgabe von Fehler- oder Informationsmeldungen verwenden.

Jede einzelne Nachricht kann dabei durch eine Bedingung (Condition) gekennzeichnet werden, die als Schlüssel für die Meldung dient, so dass die zugehörige Meldung in einer BSP nur dann ausgegeben wird, wenn die entsprechende Bedingung erfüllt ist. Somit lassen sich leicht Eingabefeld-bezogene Meldungen direkt neben den Eingabefeldern platzieren.

Zu jeder BSP existiert eine Instanz dieser Klasse, die die aktuellen Meldungen zu dieser Klasse enthält. Das Objekt wird nach jedem HTTP-Request/Response-Zyklus zurückgesetzt. Der Zugriff auf das Objekt erfolgt aus einer BSP heraus über den Parameter page der Eventhandler in Form von page->messages oder über die Eigenreferenz me in Form von Interface-Qualifizierung me->if_bsp_page~messages.

Vererbungshierarchie/Interfacekomposition

Implementierte Interfaces	-
Superklasse	-

Attribute

Attributname	Deklarationsart	Beschreibung
`co_severity_error`	Konstante	Schwere der Meldung: Fehler
`co_severity_fatal_error`	Konstante	Schwere der Meldung: Fataler Fehler
`co_severity_info`	Konstante	Schwere der Meldung: Information
`co_severity_success`	Konstante	Schwere der Meldung: Erfolgsbestätigung
`co_severity_warning`	Konstante	Schwere der Meldung: Warnung

Methoden

Methode add_message

Signatur	`method add_message importing condition type string message type string optional otr_alias type string optional severity type i default co_severity_error .`
Beschreibung	Diese Methode fügt die Nachricht unter der gegebenen Bedingung in die Liste der Meldungen ein. Existiert bereits eine Meldung unter der Bedingung, wird diese überschrieben. Es muss genau einer der beiden Parameter `message` oder `otr_alias` angegeben sein (exklusiv-oder). Bei Verwendung von `message` wird der Nachrichtentext direkt übergeben, bei Verwendung von `otr_alias` wird der Aliasname eines OTR-Textes übergeben. Hierdurch lassen sich sprachabhängige Meldungen aus dem OTR sehr einfach ansprechen.
Parameter	`CONDITION`	Bedingung der Meldung
	`MESSAGE`	Meldungstext (falls `otr_alias`-Parameter nicht verwendet wird)
	`OTR_ALIAS`	Aliasname eines OTR-Textes, der als Meldungstext verwendet werden soll (falls `message`-Parameter nicht verwendet wird)
	`SEVERITY`	Meldungssschwere (siehe Konstanten `co_severity_...`)
Return-Werte/Ausnahmen	-
Querreferenzen	Siehe auch: `assert`, `assert_message`, `assert_severity`

Methode assert

Signatur	`method assert importing condition type string returning index type i .`
Beschreibung	Diese Methode liefert den Index (1..n) der Meldung zur gegebenen Bedingung (Condition) oder 0, falls keine Meldung unter dieser Bedingung vorhanden ist. Damit kann diese Methode in BSPs in `if`-Anweisungen eingesetzt werden, um z.B. meldungsabhängig bestimmte HTML-Bereiche in die Ausgaben einzufügen. Beispiel: `... <% if page->messages->assert( 'invaliduser' ) <> 0. %> <img src="stop.gif"> <%= page->messages->assert_message( 'invaliduser' ) %> <% endif %> ...`
Parameter	`CONDITION`	Bedingung der Meldung
Return-Werte/Ausnahmen	`INDEX`	>0: Index der Meldung =0: kein Meldung zur Bedingung
Querreferenzen	Siehe auch: `assert_message`, `assert_severity`

Methode assert_message

Signatur	`method assert_message importing condition type string returning message type string .`
Beschreibung	Diese Methode liefert die Nachricht zur gegebenen Bedingung, oder einen Leerstring, falls keine Meldung unter dieser Bedingung vorhanden ist.
Parameter	`CONDITION`	Bedingung der Meldung
Return-Werte/Ausnahmen	`MESSAGE`	Nachricht
Querreferenzen	Siehe auch: `assert`, `assert_severity`

Methode assert_severity

Signatur	`method assert_severity importing condition type string returning severity type i .`
Beschreibung	Diese Methode liefert die Meldungsschwere (siehe Konstanten `co_severity_...`) zur gegebenen Bedingung (Condition) oder 0, falls keine Meldung unter dieser Bedingung vorhanden ist.
Parameter	`CONDITION`	Bedingung der Meldung
Return-Werte/Ausnahmen	`SEVERITY`	=0: kein Meldung zur Bedingung >0: Meldungsschwere (siehe Konstanten `co_severity_...`)
Querreferenzen	Siehe auch: `assert`, `assert_message`

Methode get_message

Signatur	`method get_message importing index type I exporting severity type I condition type string message type string .`
Beschreibung	Diese Methode liefert zum gegebenen Index (1..n) die Informationen über die zugehörige Meldung. Falls keine Meldung zum Index existiert, d.h. falls `index > num_messages()`, so ist dies an `severity = 0` zu erkennen.
Parameter	`INDEX`	Index der Meldung (1..num_messages())
Return-Werte/Ausnahmen	`message`	Meldungstext
	`condition`	Bedingung der Meldung
	`severity`	Meldungssschwere (siehe Konstanten `co_severity_...`)
Querreferenzen	Siehe auch: `add_message`, `num_messages`

Methode num_message

Signatur	`method num_messages returning count type I .`
Beschreibung	Diese Methode liefert die Anzahl der Meldungen zurück, die über `add_message()` definiert wurden.
Parameter	-	-
Return-Werte/Ausnahmen	`count`	Anzahl aktuell vorhandener Meldungen
Querreferenzen	Siehe auch: `add_message`