SAP ABAP Class /SRMERP/IF_MSG_HDLR (Message Handler)
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /SRMERP/CL_MSG_HDLR_BASE | Message Handler Base Class | 20100910 |
Properties
| Class | /SRMERP/IF_MSG_HDLR | |
| Short Description | Message Handler | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20100910 | SAP |
| Last change | 20131127 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  /BOBF/CM_FRW |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 2 | ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class /SRMERP/IF_MSG_HDLR has no interface implemented.
Friends
Class /SRMERP/IF_MSG_HDLR has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_ALRT_CAT |
Constant | Public | Type reference (TYPE) | SALRTDCAT | 'EPROC_ALERTS' | Alert Category | 20110729 | |
| 2 | GC_ALRT_CLNT |
Constant | Public | Type reference (TYPE) | SWFDNAME | 'MANDT' | Alert Client | 20110201 | |
| 3 | GC_ALRT_DATE |
Constant | Public | Type reference (TYPE) | SWFDNAME | 'ALERTDATE' | Alert Date | 20110201 | |
| 4 | GC_ALRT_MSG |
Constant | Public | Type reference (TYPE) | SWFDNAME | 'MSG' | Message | 20110201 | |
| 5 | GC_ALRT_SEVERITY |
Constant | Public | Type reference (TYPE) | SWFDNAME | 'ALSEVERITY' | Severity | 20110201 | |
| 6 | GC_ALRT_SUBJ |
Constant | Public | Type reference (TYPE) | SWFDNAME | 'SUBJECT_TEXT' | Subject Text | 20110113 | |
| 7 | GC_ALRT_SYS_ID |
Constant | Public | Type reference (TYPE) | SWFDNAME | 'ALSYSID' | System ID | 20110113 | |
| 8 | GC_ALRT_TIME |
Constant | Public | Type reference (TYPE) | SWFDNAME | 'ALERTTIME' | Alert Time | 20110201 | |
| 9 | GC_ALRT_USER |
Constant | Public | Type reference (TYPE) | SWFDNAME | 'USERID' | Alert User | 20110201 | |
| 10 | GC_ALRT_VAL |
Constant | Public | Type reference (TYPE) | SWFDNAME | 'ALERTVALUE' | Alert Value | 20110201 | |
| 11 | GC_MSG_AREA_ALERT |
Constant | Public | Type reference (TYPE) | T_MESSAGE_AREA | 'ALERT' | Message Area | 20101001 | |
| 12 | GC_MSG_AREA_ALL |
Constant | Public | Type reference (TYPE) | T_MESSAGE_AREA | 'ALL' | Message Area | 20101001 | |
| 13 | GC_MSG_AREA_LOG |
Constant | Public | Type reference (TYPE) | T_MESSAGE_AREA | 'LOG' | Message Area | 20101001 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_MESSAGE |
Instance method | Public | Method | Add a Message | 20100916 |
| 2 | CLEAR_MESSAGES |
Instance method | Public | Method | Clear all Messages | 20100910 |
| 3 | CLEAR_NODE_MESSAGES |
Instance method | Public | Method | Clear all Messages of a Node | 20100924 |
| 4 | COUNT_MESSAGES |
Instance method | Public | Method | Count number of messages ( ALL, Log, Alert ) | 20101001 |
| 5 | DELETE_MESSAGES |
Instance method | Public | Method | Clear all Messages from persistency | 20100928 |
| 6 | DESTROY |
Instance method | Public | Method | Destructor | 20100920 |
| 7 | GET_ALERT_MESSAGES |
Instance method | Public | Method | Get all Alert Messages | 20100930 |
| 8 | GET_LOG_HANDLE |
Instance method | Public | Method | Get Log Handle | 20100917 |
| 9 | GET_LOG_MESSAGES |
Instance method | Public | Method | Get all Log Messages | 20100921 |
| 10 | GET_NODE_MESSAGES |
Instance method | Public | Method | Clear all Messages of a Node | 20100928 |
| 11 | LOAD_MESSAGES |
Instance method | Public | Method | Load Messages | 20101001 |
| 12 | PUSH_ALERTS |
Instance method | Public | Method | Trigger Alerts | 20110413 |
| 13 | REMOVE_MESSAGE |
Instance method | Public | Method | Removes a specific message | 20110718 |
| 14 | SAVE_MESSAGES |
Instance method | Public | Method | Save all Messages to persistency | 20100917 |
| 15 | SET_LOG_IDENTIFIER |
Instance method | Public | Method | Set Log Identification | 20100924 |
Events
Class /SRMERP/IF_MSG_HDLR has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_MESSAGE_AREA | Public | See coding | Message Area | 20101001 | t_message_area TYPE c LENGTH 10
|
Method Signatures
Method ADD_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IS_MESSAGE | Call by reference | Type reference (TYPE) | SYMSG | Message Structure | 20100916 | ||
| 2 | Importing |
IV_ATTRIBUTE | Call by reference | Type reference (TYPE) | /SRMERP/MSG_ATTRIBUTE | Node Attribute to which a message refers | 20100921 | ||
| 3 | Importing |
IV_KEY | Call by reference | Type reference (TYPE) | /BOBF/CONF_KEY | NodeID | 20100916 | ||
| 4 | Importing |
IV_LOG_MESSAGE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Add message to application log | 20100921 | |
| 5 | Importing |
IV_NODE | Call by reference | Type reference (TYPE) | /BOBF/OBM_NODE_KEY | Node | 20100916 | ||
| 6 | Importing |
IV_RAISE_ALERT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Raise CCMS alert | 20100916 |
Method ADD_MESSAGE on class /SRMERP/IF_MSG_HDLR has no exception.
Method CLEAR_MESSAGES Signature
Method CLEAR_MESSAGES on class /SRMERP/IF_MSG_HDLR has no parameter.
Method CLEAR_MESSAGES on class /SRMERP/IF_MSG_HDLR has no exception.
Method CLEAR_NODE_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_KEY | Call by reference | Type reference (TYPE) | /BOBF/CONF_KEY | Key of Node | 20100924 | ||
| 2 | Importing |
IV_NODE | Call by reference | Type reference (TYPE) | /BOBF/OBM_NODE_KEY | Node | 20100924 |
Method CLEAR_NODE_MESSAGES on class /SRMERP/IF_MSG_HDLR has no exception.
Method COUNT_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_MESSAGE_AREA | Call by reference | Type reference (TYPE) | T_MESSAGE_AREA | Message Area | 20101001 | ||
| 2 |  Returning |
RV_MESSAGE_COUNT | Value transfer | Type reference (TYPE) | I | Number of messages in area | 20101001 |
Method COUNT_MESSAGES on class /SRMERP/IF_MSG_HDLR has no exception.
Method DELETE_MESSAGES Signature
Method DELETE_MESSAGES on class /SRMERP/IF_MSG_HDLR has no parameter.
Method DELETE_MESSAGES on class /SRMERP/IF_MSG_HDLR has no exception.
Method DESTROY Signature
Method DESTROY on class /SRMERP/IF_MSG_HDLR has no parameter.
Method DESTROY on class /SRMERP/IF_MSG_HDLR has no exception.
Method GET_ALERT_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RT_MESSAGES | Value transfer | Type reference (TYPE) | /SRMERP/T_MSG_STORE | Messages to raise an alert | 20100930 |
Method GET_ALERT_MESSAGES on class /SRMERP/IF_MSG_HDLR has no exception.
Method GET_LOG_HANDLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_LOG_HANDLE | Value transfer | Type reference (TYPE) | STRING | Log Handle | 20100917 |
Method GET_LOG_HANDLE on class /SRMERP/IF_MSG_HDLR has no exception.
Method GET_LOG_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RT_MESSAGES | Value transfer | Type reference (TYPE) | /SRMERP/T_MSG_STORE | Messages to be kept in application log | 20100921 |
Method GET_LOG_MESSAGES on class /SRMERP/IF_MSG_HDLR has no exception.
Method GET_NODE_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_KEY | Call by reference | Type reference (TYPE) | /BOBF/CONF_KEY | Key of Node | 20100928 | ||
| 2 | Importing |
IV_NODE | Call by reference | Type reference (TYPE) | /BOBF/OBM_NODE_KEY | Node | 20100928 | ||
| 3 | Returning |
RT_MESSAGES | Value transfer | Type reference (TYPE) | /SRMERP/T_MSG_STORE | Node messages | 20100928 |
Method GET_NODE_MESSAGES on class /SRMERP/IF_MSG_HDLR has no exception.
Method LOAD_MESSAGES Signature
Method LOAD_MESSAGES on class /SRMERP/IF_MSG_HDLR has no parameter.
Method LOAD_MESSAGES on class /SRMERP/IF_MSG_HDLR has no exception.
Method PUSH_ALERTS Signature
Method PUSH_ALERTS on class /SRMERP/IF_MSG_HDLR has no parameter.
Method PUSH_ALERTS on class /SRMERP/IF_MSG_HDLR has no exception.
Method REMOVE_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_MESSAGE | Call by reference | Type reference (TYPE) | SYMSG | 20110718 | |||
| 2 | Importing |
IV_ALERT | Call by reference | Type reference (TYPE) | BOOLEAN | ABAP_FALSE | Boolean variable | 20110723 | |
| 3 | Importing |
IV_LOG | Call by reference | Type reference (TYPE) | BOOLEAN | ABAP_FALSE | Boolean variable | 20110723 |
Method REMOVE_MESSAGE on class /SRMERP/IF_MSG_HDLR has no exception.
Method SAVE_MESSAGES Signature
Method SAVE_MESSAGES on class /SRMERP/IF_MSG_HDLR has no parameter.
Method SAVE_MESSAGES on class /SRMERP/IF_MSG_HDLR has no exception.
Method SET_LOG_IDENTIFIER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_IDENTIFIER | Call by reference | Type reference (TYPE) | ANY | Log Identifier | 20100924 |
Method SET_LOG_IDENTIFIER on class /SRMERP/IF_MSG_HDLR has no exception.
History
| Last changed by/on | SAP | 20131127 |
| SAP Release Created in |
