SAP ABAP Class CNV_00001_MESSAGE (Info / warning / error message representation)
Hierarchy
☛
DMIS (Software Component) DMIS 2011_1
⤷
CA-GTF-BS (Application Component) Business Application Support
⤷
CNV_BASIS (Package) Conversion: Basis functions
DMIS (Software Component) DMIS 2011_1⤷
CA-GTF-BS (Application Component) Business Application Support⤷
CNV_BASIS (Package) Conversion: Basis functionsProperties
| Class | CNV_00001_MESSAGE | |
| Short Description | Info / warning / error message representation | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | CNV_BASIS | Conversion: Basis functions |
| Created | 20091103 | SAP |
| Last change | 20141030 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CNV_00001_MESSAGE has no forward declaration.
Interfaces
Class CNV_00001_MESSAGE has no interface implemented.
Friends
Class CNV_00001_MESSAGE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BATCH |
Instance attribute | Protected | Type reference (TYPE) | AS4FLAG | 'X' | Display message in batch mode | 20091113 | |
| 2 | CATEGORY |
Instance attribute | Public | Type reference (TYPE) | CNV_00001_MSGCAT | Category of the message | 20091103 | ||
| 3 | DETLEVEL |
Instance attribute | Protected | Type reference (TYPE) | BALLEVEL | Application Log: Level of detail | 20091103 | ||
| 4 | DIALOG |
Instance attribute | Protected | Type reference (TYPE) | AS4FLAG | 'X' | Display message in dialog mode | 20091113 | |
| 5 | DUMMY_ICON |
Instance attribute | Protected | Type reference (TYPE) | ICON_D | ICON_LIGHT_OUT | Icon for dummy message | 20091103 | |
| 6 | ERROR |
Constant | Public | Type reference (TYPE) | CNV_00001_MSGTYPE | 'E' | Message type error | 20091103 | |
| 7 | INFO |
Constant | Public | Type reference (TYPE) | CNV_00001_MSGTYPE | 'I' | Message type info | 20091103 | |
| 8 | MSG_CLASS |
Instance attribute | Protected | Type reference (TYPE) | SYMSGID | Messages, Message Class | 20091103 | ||
| 9 | MSG_NUMBER |
Instance attribute | Protected | Type reference (TYPE) | SYMSGNO | Messages, Message Number | 20091103 | ||
| 10 | MSG_PARAMS |
Instance attribute | Protected | Type reference (TYPE) | CNV_00001_SPAR_TT | List of message parameters | 20091103 | ||
| 11 | PROBCLASS |
Instance attribute | Protected | Type reference (TYPE) | BALPROBCL | Application log: Message problem class | 20091103 | ||
| 12 | SUCCESS |
Constant | Public | Type reference (TYPE) | CNV_00001_MSGTYPE | 'S' | Message type success | 20091103 | |
| 13 | SYS_MESSAGES |
Static Attribute | Protected | Type reference (TYPE) | TY_T_T100 | List of loaded system messages | 20091103 | ||
| 14 | TYPE |
Instance attribute | Protected | Type reference (TYPE) | CNV_00001_MSGTYPE | Message type | 20091103 | ||
| 15 | TYPE_VALUE |
Instance attribute | Protected | Type reference (TYPE) | INT4 | Seriousness of a message | 20091103 | ||
| 16 | UPDATE_STATE |
Instance attribute | Protected | Type reference (TYPE) | AS4FLAG | 'X' | Whether to update overall state | 20091103 | |
| 17 | WARN |
Constant | Public | Type reference (TYPE) | CNV_00001_MSGTYPE | 'W' | Message type warning | 20091103 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_PARAM |
Instance method | Public | Method | Adds a message parameter | 20091103 |
| 2 | CLEAR_PARAMS |
Instance method | Public | Method | Removes all message parameters | 20091103 |
| 3 | CONSTRUCTOR |
Instance method | Public | Constructor | Creates a message | 20091103 |
| 4 | CREATE_MESSAGE |
Static method | Public | Method | Creates a message | 20091103 |
| 5 | DISPLAYED_IN_BATCH |
Instance method | Public | Method | Returns whether the message shall be displayed in batch mode | 20091113 |
| 6 | DISPLAYED_IN_DIALOG |
Instance method | Public | Method | Returns whether the message shall be displayed in dial. mode | 20091113 |
| 7 | GET_CLASS |
Instance method | Public | Method | Returns message class | 20091103 |
| 8 | GET_DEFAULT_ICON |
Instance method | Public | Method | Returns the icon id corresponding to the message type | 20091103 |
| 9 | GET_DETLEVEL |
Instance method | Public | Method | Returns detail level of the message | 20091103 |
| 10 | GET_DUMMY |
Static method | Public | Method | Returns dummy message | 20091103 |
| 11 | GET_ICON_FOR_TYPE |
Static method | Public | Method | Returns icon for type | 20091103 |
| 12 | GET_NUMBER |
Instance method | Public | Method | Returns message number | 20091103 |
| 13 | GET_PARAMETER |
Instance method | Public | Method | Returns one of the parameters | 20091103 |
| 14 | GET_PROBCLASS |
Instance method | Public | Method | Returns problem class of the message | 20091103 |
| 15 | GET_SERIOUSNESS |
Static method | Public | Method | Returns seriousness as a number | 20091103 |
| 16 | GET_SEVERITY |
Instance method | Public | Method | Gets severity of a message as a number | 20091103 |
| 17 | GET_TEXT |
Instance method | Public | Method | Returns the text of the message | 20091103 |
| 18 | GET_TYPE |
Instance method | Public | Method | Returns message type | 20091103 |
| 19 | IS_MORE_SERIOUS_THAN |
Instance method | Public | Method | Returns if this message is more serious than given type | 20091103 |
| 20 | IS_STATE_UPDATED |
Instance method | Public | Method | Returns whether state is updated with this message | 20091103 |
| 21 | LOAD_SYS_MESSAGES |
Static method | Protected | Method | Loads system messages | 20091103 |
| 22 | UPDATE_BY_PARAMS |
Instance method | Public | Method | Replaces placeholders in the variable with parameters | 20091103 |
Events
Class CNV_00001_MESSAGE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_T_T100 | Protected | See coding | List of loaded system messages | 20091103 | |
Method Signatures
Method ADD_PARAM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
NAME | Call by reference | Type reference (TYPE) | SPO_PAR | Parameter name | 20091103 | ||
| 2 | Importing |
VALUE | Call by reference | Type reference (TYPE) | SPO_VAL | Parameter value | 20091103 |
Method ADD_PARAM on class CNV_00001_MESSAGE has no exception.
Method CLEAR_PARAMS Signature
Method CLEAR_PARAMS on class CNV_00001_MESSAGE has no parameter.
Method CLEAR_PARAMS on class CNV_00001_MESSAGE has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CATEGORY | Call by reference | Type reference (TYPE) | CNV_00001_MSGCAT | Category of a message | 20091103 | ||
| 2 | Importing |
MSG_CLASS | Call by reference | Type reference (TYPE) | SYMSGID | Messages, Message Class | 20091103 | ||
| 3 | Importing |
MSG_NUMBER | Call by reference | Type reference (TYPE) | SYMSGNO | Messages, Message Number | 20091103 | ||
| 4 | Importing |
TYPE | Call by reference | Type reference (TYPE) | CNV_00001_MSGTYPE | CNV_00001_MESSAGE=>INFO | Message type | 20091103 |
Method CONSTRUCTOR on class CNV_00001_MESSAGE has no exception.
Method CREATE_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CATEGORY | Call by reference | Type reference (TYPE) | CNV_00001_MSGCAT | Category of a message | 20091103 | ||
| 2 |  Returning |
MESSAGE | Value transfer | Object reference (TYPE REF TO) | CNV_00001_MESSAGE | Info / warning / error message representation | 20091103 | ||
| 3 | Importing |
MSG_CLASS | Call by reference | Type reference (TYPE) | SYMSGID | Messages, Message Class | 20091103 | ||
| 4 | Importing |
MSG_DETLEVEL | Call by reference | Type reference (TYPE) | BALLEVEL | '2' | Application Log: Level of detail | 20091103 | |
| 5 | Importing |
MSG_NUMBER | Call by reference | Type reference (TYPE) | SYMSGNO | Messages, Message Number | 20091103 | ||
| 6 | Importing |
MSG_PARAM1 | Call by reference | Type reference (TYPE) | ANY | Messages, message variables | 20091103 | ||
| 7 | Importing |
MSG_PARAM2 | Call by reference | Type reference (TYPE) | ANY | Messages, message variables | 20091103 | ||
| 8 | Importing |
MSG_PARAM3 | Call by reference | Type reference (TYPE) | ANY | Messages, message variables | 20091103 | ||
| 9 | Importing |
MSG_PARAM4 | Call by reference | Type reference (TYPE) | ANY | Messages, message variables | 20091103 | ||
| 10 | Importing |
MSG_PROBCLASS | Call by reference | Type reference (TYPE) | BALPROBCL | '2' | Application log: Message problem class | 20091103 | |
| 11 | Importing |
ONLY_BATCH | Call by reference | Type reference (TYPE) | AS4FLAG | SPACE | Message should only be displayed in batch mode | 20091113 | |
| 12 | Importing |
ONLY_DIALOG | Call by reference | Type reference (TYPE) | AS4FLAG | SPACE | Message should only be displayed in dialog mode | 20091113 | |
| 13 | Importing |
TYPE | Call by reference | Type reference (TYPE) | CNV_00001_MSGTYPE | CNV_00001_MESSAGE=>SUCCESS | Message type | 20091103 | |
| 14 | Importing |
UPDATE_STATE | Call by reference | Type reference (TYPE) | AS4FLAG | 'X' | whether to update state | 20091103 |
Method CREATE_MESSAGE on class CNV_00001_MESSAGE has no exception.
Method DISPLAYED_IN_BATCH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RET | Value transfer | Type reference (TYPE) | AS4FLAG | Flag (X or blank) | 20091113 |
Method DISPLAYED_IN_BATCH on class CNV_00001_MESSAGE has no exception.
Method DISPLAYED_IN_DIALOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RET | Value transfer | Type reference (TYPE) | AS4FLAG | Flag (X or blank) | 20091113 |
Method DISPLAYED_IN_DIALOG on class CNV_00001_MESSAGE has no exception.
Method GET_CLASS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
MSG_CLASS | Value transfer | Type reference (TYPE) | SYMSGID | Messages, Message Class | 20091103 |
Method GET_CLASS on class CNV_00001_MESSAGE has no exception.
Method GET_DEFAULT_ICON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
ICON | Value transfer | Type reference (TYPE) | ICON_D | Icon id | 20091103 | ||
| 2 | Importing |
SMALL | Call by reference | Type reference (TYPE) | AS4FLAG | SPACE | Flag (X or blank) | 20091103 |
Method GET_DEFAULT_ICON on class CNV_00001_MESSAGE has no exception.
Method GET_DETLEVEL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
DETLEVEL | Value transfer | Type reference (TYPE) | BALLEVEL | Application Log: Level of detail | 20091103 |
Method GET_DETLEVEL on class CNV_00001_MESSAGE has no exception.
Method GET_DUMMY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ICON | Call by reference | Type reference (TYPE) | ICON_D | Icon in text fields (substitute display, alias) | 20091103 | ||
| 2 | Returning |
MESSAGE | Value transfer | Object reference (TYPE REF TO) | CNV_00001_MESSAGE | Info / warning / error message representation | 20091103 |
Method GET_DUMMY on class CNV_00001_MESSAGE has no exception.
Method GET_ICON_FOR_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
ICON | Value transfer | Type reference (TYPE) | ICON_D | Icon in text fields (substitute display, alias) | 20091103 | ||
| 2 | Importing |
SMALL | Call by reference | Type reference (TYPE) | AS4FLAG | SPACE | Flag (X or blank) | 20091103 | |
| 3 | Importing |
TYPE | Call by reference | Type reference (TYPE) | CNV_00001_MSGTYPE | Message type | 20091103 |
Method GET_ICON_FOR_TYPE on class CNV_00001_MESSAGE has no exception.
Method GET_NUMBER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
MSG_NUMBER | Value transfer | Type reference (TYPE) | SYMSGNO | Messages, Message Number | 20091103 |
Method GET_NUMBER on class CNV_00001_MESSAGE has no exception.
Method GET_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
NAME | Call by reference | Type reference (TYPE) | SPO_PAR | Parameter name | 20091103 | ||
| 2 | Returning |
PARAM | Value transfer | Type reference (TYPE) | SPO_VAL | Messages, message variables | 20091103 |
Method GET_PARAMETER on class CNV_00001_MESSAGE has no exception.
Method GET_PROBCLASS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
PROBCLASS | Value transfer | Type reference (TYPE) | BALPROBCL | Application log: Message problem class | 20091103 |
Method GET_PROBCLASS on class CNV_00001_MESSAGE has no exception.
Method GET_SERIOUSNESS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RES | Value transfer | Type reference (TYPE) | INT4 | Natural number | 20091103 | ||
| 2 | Importing |
TYPE | Call by reference | Type reference (TYPE) | CNV_00001_MSGTYPE | Message type | 20091103 |
Method GET_SERIOUSNESS on class CNV_00001_MESSAGE has no exception.
Method GET_SEVERITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
SEVERITY | Value transfer | Type reference (TYPE) | INT4 | Natural number | 20091103 |
Method GET_SEVERITY on class CNV_00001_MESSAGE has no exception.
Method GET_TEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
LANG | Call by reference | Type reference (TYPE) | SYLANGU | SY-LANGU | R/3 System, current language | 20091103 | |
| 2 | Returning |
TEXT | Value transfer | Type reference (TYPE) | STRING | Text of the message | 20091103 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  MESSAGE_NOT_FOUND |
Message was not found | 20091103 |
Method GET_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
TYPE | Value transfer | Type reference (TYPE) | CNV_00001_MSGTYPE | Message type | 20091103 |
Method GET_TYPE on class CNV_00001_MESSAGE has no exception.
Method IS_MORE_SERIOUS_THAN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RES | Value transfer | Type reference (TYPE) | AS4FLAG | Flag (X or blank) | 20091103 | ||
| 2 | Importing |
TYPE | Call by reference | Type reference (TYPE) | CNV_00001_MSGTYPE | Message type | 20091103 |
Method IS_MORE_SERIOUS_THAN on class CNV_00001_MESSAGE has no exception.
Method IS_STATE_UPDATED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RET | Value transfer | Type reference (TYPE) | AS4FLAG | Flag (X or blank) | 20091103 |
Method IS_STATE_UPDATED on class CNV_00001_MESSAGE has no exception.
Method LOAD_SYS_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
LANG | Call by reference | Type reference (TYPE) | SYLANGU | R/3 System, current language | 20091103 | ||
| 2 | Importing |
MSG_CLASS | Call by reference | Type reference (TYPE) | SYMSGID | Messages, Message Class | 20091103 |
Method LOAD_SYS_MESSAGES on class CNV_00001_MESSAGE has no exception.
Method UPDATE_BY_PARAMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
VALUE | Call by reference | Type reference (TYPE) | ANY | Value | 20091103 |
Method UPDATE_BY_PARAMS on class CNV_00001_MESSAGE has no exception.
History
| Last changed by/on | SAP | 20141030 |
| SAP Release Created in | 46C |
