SAP ABAP Class CL_MESSAGE_HELPER (Auxiliary Class for the MESSAGE Statement)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
⤷ S_ABAP_EXCEPTIONS (Package) ABAP Runtime Errors as System Exceptions
⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
⤷ S_ABAP_EXCEPTIONS (Package) ABAP Runtime Errors as System Exceptions
Properties
Class | CL_MESSAGE_HELPER | |
Short Description | Auxiliary Class for the MESSAGE Statement | |
Super Class | ||
Instantiability of a Class | 0 | Private |
Final |
General Data
Message Class | ||
Program status | ||
Category | 0 | |
Package | S_ABAP_EXCEPTIONS | ABAP Runtime Errors as System Exceptions |
Created | 20020114 | SAP |
Last change | 20130531 | SAP |
Shared Memory-enabled | ||
Fixed point arithmetic | ||
Unicode checks active |
Forward declarations
# | Type group / Object type | Type | Type Description |
---|---|---|---|
1 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_MESSAGE_HELPER has no interface implemented.
Friends
Class CL_MESSAGE_HELPER has no friend class.
Attributes
# | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | MESSAGE_OBJECT | Static Attribute | Public | Object reference (TYPE REF TO) | IF_MESSAGE | The message object used by MESSAGE | 20020114 |
Methods
# | Method | Level | Visibility | Method type | Description | Created on |
---|---|---|---|---|---|---|
1 | CHECK_MSG_KIND | Static method | Public | Method | Sets Appropriate Key for MESSAGE | 20070309 |
2 | GET_LONGTEXT_FOR_MESSAGE | Static method | Public | Method | Returns Long Text for Parameter(s) | 20030929 |
3 | GET_OTR_LONGTEXT_RAW | Static method | Private | Method | Returns OTR Short Text Without Parameter Setting | 20090330 |
4 | GET_OTR_TEXT_RAW | Static method | Public | Method | Returns OTR Short Text Without Parameter Setting | 20090330 |
5 | GET_T100_LONGTEXT_FOR | Static method | Private | Method | Returns Long Text from T100 | 20030929 |
6 | GET_T100_LONGTEXT_ITF | Static method | Private | Method | Returns Long Text from T100 | 20090330 |
7 | GET_T100_TEXT_FOR | Static method | Public | Method | Returns T100 Short Text | 20090330 |
8 | GET_TEXT_FOR_MESSAGE | Static method | Public | Method | Returns Short Text for Parameter(s) | 20030929 |
9 | GET_TEXT_PARAMS | Static method | Public | Method | Returns Text Parameter | 20070309 |
10 | GET_TEXT_SPARAMS | Static method | Public | Method | Returns Text Parameter | 20090330 |
11 | REPLACE_TEXT_PARAMS | Static method | Public | Method | Replaces Text Parameter | 20090330 |
12 | SET_MSG_VARS_FOR_ANY | Static method | Public | Method | Sets MESSAGE Variables, if Text Is of Type ANY | 20030807 |
13 | SET_MSG_VARS_FOR_CLIKE | Static method | Public | Method | Sets MESSAGE Variables, if Text Is of Type CLIKE | 20030806 |
14 | SET_MSG_VARS_FOR_IF_MSG | Static method | Public | Method | Sets MESSAGE Variables, REF TO IF_MESSAGE | 20040518 |
15 | SET_MSG_VARS_FOR_IF_T100_MSG | Static method | Public | Method | Sets MESSAGE Variables, REF TO IF_T100_MESSAGE | 20030806 |
16 | SET_SINGLE_MSG_VAR | Static method | Private | Method | Sets Single MESSAGE Variable | 20030806 |
17 | SET_SINGLE_MSG_VAR_CLIKE | Static method | Private | Method | Executes MOVE for Setting of MESSAGE Variable | 20040504 |
18 | SET_SINGLE_MSG_VAR_NUMERIC | Static method | Private | Method | Executes MOVE for Setting of MESSAGE Variable | 20040504 |
19 | SET_SINGLE_MSG_VAR_XSEQ | Static method | Private | Method | Executes MOVE for Setting of MESSAGE Variable | 20040504 |
20 | STRIP_NEWLINES_FROM | Static method | Public | Method | Replaces New Lines with Blank Characters | 20090330 |
Events
Class CL_MESSAGE_HELPER has no event.
Types
Class CL_MESSAGE_HELPER has no local type.
Method Signatures
Method CHECK_MSG_KIND Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | MSG | Value transfer | Object reference (TYPE REF TO) | IF_MESSAGE | Meldungsobjekt | 20070309 | ||
2 | Exporting | T100KEY | Value transfer | Type reference (TYPE) | SCX_T100KEY | T100 Schlüssel mit Abbildung der Parameter auf Attributnamen | 20070309 | ||
3 | Exporting | TEXTID | Value transfer | Type reference (TYPE) | SOTR_CONC | Schlüssel zum logischen Objekt im OTR | 20070309 |
Method CHECK_MSG_KIND on class CL_MESSAGE_HELPER has no exception.
Method GET_LONGTEXT_FOR_MESSAGE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | PRESERVE_NEWLINES | Value transfer | Type reference (TYPE) | ABAP_BOOL | Wahr, wenn Zeilenumbrüche nicht durch Spaces ersetzt werden | 20040618 | ||
2 | Returning | RESULT | Value transfer | Type reference (TYPE) | STRING | 20030929 | |||
3 | Importing | T100_PREPEND_SHORT | Value transfer | Type reference (TYPE) | ABAP_BOOL | 'X' | Wahr, wenn bei T100-Texten der Kurztext vorangestellt wird | 20090330 | |
4 | Importing | TEXT | Value transfer | Object reference (TYPE REF TO) | IF_MESSAGE | Message | 20030929 |
Method GET_LONGTEXT_FOR_MESSAGE on class CL_MESSAGE_HELPER has no exception.
Method GET_OTR_LONGTEXT_RAW Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | RESULT | Call by reference | Type reference (TYPE) | STRING | Langtext | 20090330 | ||
2 | Importing | TEXTID | Call by reference | Type reference (TYPE) | SOTR_CONC | Schlüssel zum logischen Objekt im OTR | 20090330 |
Method GET_OTR_LONGTEXT_RAW on class CL_MESSAGE_HELPER has no exception.
Method GET_OTR_TEXT_RAW Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | RESULT | Call by reference | Type reference (TYPE) | STRING | Kurztext | 20090330 | ||
2 | Importing | TEXTID | Call by reference | Type reference (TYPE) | SOTR_CONC | Schlüssel zum logischen Objekt im OTR | 20090330 |
Method GET_OTR_TEXT_RAW on class CL_MESSAGE_HELPER has no exception.
Method GET_T100_LONGTEXT_FOR Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | OBJ | Value transfer | Object reference (TYPE REF TO) | OBJECT | Objekt | 20090330 | ||
2 | Importing | PREPEND_SHORT | Value transfer | Type reference (TYPE) | ABAP_BOOL | 'X' | Wahr, wenn der Kurztext vorangestellt werden soll | 20090330 | |
3 | Exporting | RESULT | Value transfer | Type reference (TYPE) | STRING | 20030929 | |||
4 | Importing | T100KEY | Call by reference | Type reference (TYPE) | SCX_T100KEY | T100 Schlüssel mit Abbildung der Parameter auf Attributnamen | 20090330 | ||
5 | Importing | TEXT | Value transfer | Object reference (TYPE REF TO) | IF_MESSAGE | Schnittstelle zum Zugriff auf Texte von Meldungsobjekten | 20090330 |
Method GET_T100_LONGTEXT_FOR on class CL_MESSAGE_HELPER has no exception.
Method GET_T100_LONGTEXT_ITF Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | ITF_ITAB | Call by reference | Type reference (TYPE) | TLINE_TAB | Liste von Sapscript Zeilen | 20090330 | ||
2 | Importing | OBJ | Value transfer | Object reference (TYPE REF TO) | OBJECT | Objekt | 20090330 | ||
3 | Importing | T100KEY | Call by reference | Type reference (TYPE) | SCX_T100KEY | T100 Schlüssel mit Abbildung der Parameter auf Attributnamen | 20090330 |
Method GET_T100_LONGTEXT_ITF on class CL_MESSAGE_HELPER has no exception.
Method GET_T100_TEXT_FOR Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | OBJ | Value transfer | Object reference (TYPE REF TO) | OBJECT | Objekt | 20090330 | ||
2 | Exporting | RESULT | Call by reference | Type reference (TYPE) | STRING | Kurztext | 20090330 | ||
3 | Importing | T100KEY | Call by reference | Type reference (TYPE) | SCX_T100KEY | T100 Schlüssel mit Abbildung der Parameter auf Attributnamen | 20090330 |
Method GET_T100_TEXT_FOR on class CL_MESSAGE_HELPER has no exception.
Method GET_TEXT_FOR_MESSAGE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Returning | RESULT | Value transfer | Type reference (TYPE) | STRING | 20030929 | |||
2 | Importing | TEXT | Value transfer | Object reference (TYPE REF TO) | IF_MESSAGE | Message-Instanz | 20030929 |
Method GET_TEXT_FOR_MESSAGE on class CL_MESSAGE_HELPER has no exception.
Method GET_TEXT_PARAMS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | OBJ | Value transfer | Object reference (TYPE REF TO) | OBJECT | 20070309 | |||
2 | Exporting | PARAMS | Call by reference | Type reference (TYPE) | SOTR_PARAMS | Tabelle mit Zuordnung von Parameter und Wert | 20070309 |
Method GET_TEXT_PARAMS on class CL_MESSAGE_HELPER has no exception.
Method GET_TEXT_SPARAMS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | OBJ | Value transfer | Object reference (TYPE REF TO) | OBJECT | Objekt | 20090330 | ||
2 | Exporting | PARAMS | Call by reference | Type reference (TYPE) | SBTFR_PARAM_TT | Parameter | 20090330 |
Method GET_TEXT_SPARAMS on class CL_MESSAGE_HELPER has no exception.
Method REPLACE_TEXT_PARAMS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | OBJ | Value transfer | Object reference (TYPE REF TO) | OBJECT | Objekt | 20090330 | ||
2 | Changing | RESULT | Call by reference | Type reference (TYPE) | STRING | Text | 20090330 |
Method REPLACE_TEXT_PARAMS on class CL_MESSAGE_HELPER has no exception.
Method SET_MSG_VARS_FOR_ANY Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | STRING | Value transfer | Type reference (TYPE) | STRING | 20040518 | |||
2 | Importing | TEXT | Call by reference | Type reference (TYPE) | ANY | 20030807 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SY_MESSAGE_ILLEGAL_TEXT | Ungültiger MESSAGE Text-Parameter | 20030807 |
Method SET_MSG_VARS_FOR_CLIKE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | TEXT | Value transfer | Type reference (TYPE) | CLIKE | Text | 20030806 |
Method SET_MSG_VARS_FOR_CLIKE on class CL_MESSAGE_HELPER has no exception.
Method SET_MSG_VARS_FOR_IF_MSG Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | STRING | Value transfer | Type reference (TYPE) | STRING | String zur Übergabe an MESSAGE | 20040518 | ||
2 | Importing | TEXT | Value transfer | Object reference (TYPE REF TO) | IF_MESSAGE | Schnittstelle zum Zugriff auf Texte von Meldungsobjekten | 20040518 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SY_MESSAGE_ILLEGAL_TEXT | Ungültiger MESSAGE Text-Parameter | 20040518 |
Method SET_MSG_VARS_FOR_IF_T100_MSG Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | TEXT | Value transfer | Object reference (TYPE REF TO) | IF_T100_MESSAGE | 20030806 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SY_MESSAGE_ILLEGAL_TEXT | Ungültiger MESSAGE Text-Parameter | 20030806 |
Method SET_SINGLE_MSG_VAR Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | ARG | Call by reference | Type reference (TYPE) | CLIKE | 20030807 | |||
2 | Importing | OBJ | Value transfer | Object reference (TYPE REF TO) | OBJECT | 20030807 | |||
3 | Exporting | TARGET | Call by reference | Type reference (TYPE) | C | 20030807 |
Method SET_SINGLE_MSG_VAR on class CL_MESSAGE_HELPER has no exception.
Method SET_SINGLE_MSG_VAR_CLIKE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | ARG | Call by reference | Type reference (TYPE) | CLIKE | 20040504 | |||
2 | Exporting | TARGET | Call by reference | Type reference (TYPE) | C | 20040504 |
Method SET_SINGLE_MSG_VAR_CLIKE on class CL_MESSAGE_HELPER has no exception.
Method SET_SINGLE_MSG_VAR_NUMERIC Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | ARG | Call by reference | Type reference (TYPE) | NUMERIC | 20040504 | |||
2 | Exporting | TARGET | Call by reference | Type reference (TYPE) | C | 20040504 |
Method SET_SINGLE_MSG_VAR_NUMERIC on class CL_MESSAGE_HELPER has no exception.
Method SET_SINGLE_MSG_VAR_XSEQ Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | ARG | Call by reference | Type reference (TYPE) | XSEQUENCE | 20040504 | |||
2 | Exporting | TARGET | Call by reference | Type reference (TYPE) | C | 20040504 |
Method SET_SINGLE_MSG_VAR_XSEQ on class CL_MESSAGE_HELPER has no exception.
Method STRIP_NEWLINES_FROM Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Changing | MESSAGE | Call by reference | Type reference (TYPE) | STRING | Text | 20090330 |
Method STRIP_NEWLINES_FROM on class CL_MESSAGE_HELPER has no exception.
History
Last changed by/on | SAP | 20130531 |
SAP Release Created in | 630 |