SAP ABAP Class CL_DB2_MESSAGE_QUEUE (This class handles messages for the failover component)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-DB-DB2 (Application Component) DB2 for z/OS
⤷
STU2 (Package) CCMS for DB2 for OS/390
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-DB-DB2 (Application Component) DB2 for z/OS⤷
STU2 (Package) CCMS for DB2 for OS/390Properties
| Class | CL_DB2_MESSAGE_QUEUE | |
| Short Description | This class handles messages for the failover component | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | STU2 | CCMS for DB2 for OS/390 |
| Created | 20120614 | 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_DB2_MESSAGE_QUEUE has no interface implemented.
Friends
Class CL_DB2_MESSAGE_QUEUE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ERROR_MSG |
Static Attribute | Public | Type reference (TYPE) | DB2CHAR03 | 'ERR' | Field type char, length 3 | 20120614 | |
| 2 | EXCEPT_MSG |
Static Attribute | Public | Type reference (TYPE) | DB2CHAR03 | 'EXC' | Field type char, length 3 | 20120614 | |
| 3 | INFO_MSG |
Static Attribute | Public | Type reference (TYPE) | DB2CHAR03 | 'INF' | Field type char, length 3 | 20120614 | |
| 4 | MESSAGES |
Instance attribute | Private | Type reference (TYPE) | MSG_TAB | central message queue | 20120614 | ||
| 5 | NAVIGATOR |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_DB6_TREE_NAVIGATOR | CL_DB6_TREE_NAVIGATOR | 20120622 | ||
| 6 | SINGLETON_INSTANCE |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_DB2_MESSAGE_QUEUE | holds the only available instance of this class | 20120614 | ||
| 7 | SUCCESS_MSG |
Static Attribute | Public | Type reference (TYPE) | DB2CHAR03 | 'SUC' | Field type char, length 3 | 20120614 | |
| 8 | T100_MSG |
Static Attribute | Public | Type reference (TYPE) | DB2CHAR03 | 'T10' | Field type char, length 3 | 20120614 | |
| 9 | WARN_MSG |
Static Attribute | Public | Type reference (TYPE) | DB2CHAR03 | 'WAR' | Field type char, length 3 | 20120614 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_ERROR |
Instance method | Public | Method | adds a message to the internal queue | 20120614 |
| 2 | ADD_EXCEPTION |
Instance method | Public | Method | adds a message to the internal queue | 20120614 |
| 3 | ADD_INFO |
Instance method | Public | Method | adds a message to the internal queue | 20120614 |
| 4 | ADD_SQL_EXCEPTION |
Instance method | Public | Method | adds a prepared text with exception information to the queue | 20120629 |
| 5 | ADD_SUCCESS |
Instance method | Public | Method | adds a message to the internal queue | 20120614 |
| 6 | ADD_T100 |
Instance method | Public | Method | adds a t100 to the message queue | 20120614 |
| 7 | ADD_WARNING |
Instance method | Public | Method | adds a message to the internal queue | 20120614 |
| 8 | CREATE |
Static method | Public | Method | creates the only instance of this class | 20120614 |
| 9 | GET_MESSAGES |
Instance method | Public | Method | get messages (if print_messages is not possible) | 20120620 |
| 10 | PRINT_MESSAGES |
Instance method | Public | Method | print the collected messages, queue flushed afterwards | 20120614 |
Events
Class CL_DB2_MESSAGE_QUEUE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | MSG_LINE | Public | See coding | 20120620 | BEGIN OF msg_line,
msg TYPE string,
longtext TYPE string,
sysid TYPE db6navsyst-sysid,
msg_type(3) TYPE c,
excp_ref TYPE REF TO cx_dba_root,
t100_msg TYPE dba_msg,
END OF msg_line
|
||
| 2 | MSG_TAB | Public | See coding | 20120620 | msg_tab TYPE STANDARD TABLE OF msg_line
|
Method Signatures
Method ADD_ERROR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
LONGTEXT | Call by reference | Type reference (TYPE) | STRING | further details regarding the error | 20120614 | ||
| 2 | Importing |
MSG | Call by reference | Type reference (TYPE) | STRING | short message to be printed | 20120614 | ||
| 3 | Importing |
SYSID | Call by reference | Type reference (TYPE) | DB6NAVSYST-SYSID | system id the message belongs to | 20120614 |
Method ADD_ERROR on class CL_DB2_MESSAGE_QUEUE has no exception.
Method ADD_EXCEPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
EXCP_REF | Call by reference | Object reference (TYPE REF TO) | CX_ROOT | Abstract Superclass for All Global Exceptions | 20120614 | ||
| 2 | Importing |
LONGTEXT | Call by reference | Type reference (TYPE) | STRING | further details regarding the error | 20120614 | ||
| 3 | Importing |
MSG | Call by reference | Type reference (TYPE) | STRING | short message to be printed | 20120614 | ||
| 4 | Importing |
SYSID | Call by reference | Type reference (TYPE) | DB6NAVSYST-SYSID | system id the message belongs to | 20120614 |
Method ADD_EXCEPTION on class CL_DB2_MESSAGE_QUEUE has no exception.
Method ADD_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
LONGTEXT | Call by reference | Type reference (TYPE) | STRING | further details regarding the error | 20120614 | ||
| 2 | Importing |
MSG | Call by reference | Type reference (TYPE) | STRING | short message to be printed | 20120614 | ||
| 3 | Importing |
SYSID | Call by reference | Type reference (TYPE) | DB6NAVSYST-SYSID | system id the message belongs to | 20120614 |
Method ADD_INFO on class CL_DB2_MESSAGE_QUEUE has no exception.
Method ADD_SQL_EXCEPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
SQLERR_REF | Call by reference | Object reference (TYPE REF TO) | CX_SQL_EXCEPTION | Exception Class for SQL Error | 20130712 | ||
| 2 | Importing |
SQL_NATIVE_ERR_REF | Call by reference | Object reference (TYPE REF TO) | CX_SY_NATIVE_SQL_ERROR | Native SQL Error | 20120629 | ||
| 3 | Importing |
SYSID | Call by reference | Type reference (TYPE) | DB6NAVSYST-SYSID | Name of the SAP System | 20120629 |
Method ADD_SQL_EXCEPTION on class CL_DB2_MESSAGE_QUEUE has no exception.
Method ADD_SUCCESS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
LONGTEXT | Call by reference | Type reference (TYPE) | STRING | further details regarding the error | 20120614 | ||
| 2 | Importing |
MSG | Call by reference | Type reference (TYPE) | STRING | short message to be printed | 20120614 | ||
| 3 | Importing |
SYSID | Call by reference | Type reference (TYPE) | DB6NAVSYST-SYSID | system id the message belongs to | 20120614 |
Method ADD_SUCCESS on class CL_DB2_MESSAGE_QUEUE has no exception.
Method ADD_T100 Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
MSGID | Call by reference | Type reference (TYPE) | SYMSGID | Message Class | 20120614 | ||
| 2 | Importing |
MSGNO | Call by reference | Type reference (TYPE) | SYMSGNO | Message Number | 20120614 | ||
| 3 | Importing |
MSGTY | Call by reference | Type reference (TYPE) | SYMSGTY | Message Type | 20120614 | ||
| 4 | Importing |
MSGV1 | Call by reference | Type reference (TYPE) | ANY | 20120614 | |||
| 5 | Importing |
MSGV2 | Call by reference | Type reference (TYPE) | ANY | 20120614 | |||
| 6 | Importing |
MSGV3 | Call by reference | Type reference (TYPE) | ANY | 20120614 | |||
| 7 | Importing |
MSGV4 | Call by reference | Type reference (TYPE) | ANY | 20120614 | |||
| 8 | Importing |
SYSID | Call by reference | Type reference (TYPE) | DB6NAVSYST-SYSID | Name of the SAP System | 20120614 |
Method ADD_T100 on class CL_DB2_MESSAGE_QUEUE has no exception.
Method ADD_WARNING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
LONGTEXT | Call by reference | Type reference (TYPE) | STRING | further details regarding the error | 20120614 | ||
| 2 | Importing |
MSG | Call by reference | Type reference (TYPE) | STRING | short message to be printed | 20120614 | ||
| 3 | Importing |
SYSID | Call by reference | Type reference (TYPE) | DB6NAVSYST-SYSID | system id the message belongs to | 20120614 |
Method ADD_WARNING on class CL_DB2_MESSAGE_QUEUE has no exception.
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
SINGLETON_INSTANCE_RET | Value transfer | Object reference (TYPE REF TO) | CL_DB2_MESSAGE_QUEUE | created singleton instance | 20120614 |
Method CREATE on class CL_DB2_MESSAGE_QUEUE has no exception.
Method GET_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
MESSAGES | Value transfer | Type reference (TYPE) | MSG_TAB | 20120620 |
Method GET_MESSAGES on class CL_DB2_MESSAGE_QUEUE has no exception.
Method PRINT_MESSAGES Signature
Method PRINT_MESSAGES on class CL_DB2_MESSAGE_QUEUE has no parameter.
Method PRINT_MESSAGES on class CL_DB2_MESSAGE_QUEUE has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 740 |
