SAP ABAP Class CL_XMS_MSG_REF (CL_XMS_MSG_REF)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-XI-IS-IEN (Application Component) Integration Engine
⤷
SXMSJOB (Package) XI: Time-Driven Message Processing
⤷
⤷
Properties
| Class | CL_XMS_MSG_REF | |
| Short Description | ||
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SXMSJOB | XI: Time-Driven Message Processing |
| Created | 20030422 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_XMS_MSG_REF has no forward declaration.
Interfaces
Class CL_XMS_MSG_REF has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_XMS_MSG_REFS | 20050308 |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_XMS_MSG_REFS | 20030512 | ||||
| 2 | Instance attribute | Protected | Type reference (TYPE) | SXMSMSGREF | 20030424 | ||||
| 3 | Instance attribute | Protected | Type reference (TYPE) | CHAR1 | Single-Character Indicator | 20040601 | |||
| 4 | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_XMS_QUEUEING_SYSTEM | Queueing System API | 20090506 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | 20041115 | ||
| 2 | Instance method | Public | Method | 20041115 | ||
| 3 | Instance method | Public | Constructor | Constructor | 20030422 | |
| 4 | Instance method | Public | Method | Insert Message in Queue | 20041116 | |
| 5 | Instance method | Public | Method | All data | 20030522 | |
| 6 | Instance method | Public | Method | 20041115 | ||
| 7 | Instance method | Public | Method | Message ID | 20030515 | |
| 8 | Instance method | Public | Method | 20041115 | ||
| 9 | Instance method | Public | Method | 20041115 | ||
| 10 | Instance method | Public | Method | 20041115 | ||
| 11 | Instance method | Public | Method | Sets the process ID | 20041115 | |
| 12 | Instance method | Public | Method | 20041115 | ||
| 13 | Instance method | Public | Method | 20041115 | ||
| 14 | Instance method | Public | Method | 20041115 |
Events
Class CL_XMS_MSG_REF has no event.
Types
Class CL_XMS_MSG_REF has no local type.
Method Signatures
Method CLEANUP_PENDING_VERSION Signature
Method CLEANUP_PENDING_VERSION on class CL_XMS_MSG_REF has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XI: Systemfehler | 20041115 |
Method CLEAR_PROCESS_ID Signature
Method CLEAR_PROCESS_ID on class CL_XMS_MSG_REF has no parameter.
Method CLEAR_PROCESS_ID on class CL_XMS_MSG_REF has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DB | Call by reference | Type reference (TYPE) | CHAR1 | 20030519 | ||||
| 2 | MESSAGE_REF | Call by reference | Type reference (TYPE) | SXMSMSGREF | 20030514 | ||||
| 3 | MSGREFS | Call by reference | Object reference (TYPE REF TO) | CL_XMS_MSG_REFS | 20030512 | ||||
| 4 | PMI_ON | Call by reference | Type reference (TYPE) | CHAR1 | Einstelliges Kennzeichen | 20040601 |
Method CONSTRUCTOR on class CL_XMS_MSG_REF has no exception.
Method ENTER_XMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | LOG | Value transfer | Object reference (TYPE REF TO) | CL_XMS_LOG | 20041116 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XI: Systemfehler | 20041116 |
Method GET_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MSGREF_WA | Value transfer | Type reference (TYPE) | SXMSMSGREF | 20030522 |
Method GET_DATA on class CL_XMS_MSG_REF has no exception.
Method GET_FILTER_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | FILTER_ID | Value transfer | Type reference (TYPE) | SXMSFILTERGUID | Filter-ID | 20041115 |
Method GET_FILTER_ID on class CL_XMS_MSG_REF has no exception.
Method GET_MESSAGE_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MESSAGE_ID | Value transfer | Type reference (TYPE) | SXMSMSGREF-MESSAGE_ID | 20030515 |
Method GET_MESSAGE_ID on class CL_XMS_MSG_REF has no exception.
Method GET_MSG_VERSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | VERSION | Value transfer | Type reference (TYPE) | SXMSLSQNBR | Fortlaufende Nummer für ID eines Message-Log | 20041115 |
Method GET_MSG_VERSION on class CL_XMS_MSG_REF has no exception.
Method GET_PIPELINE_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PID | Value transfer | Type reference (TYPE) | SXMSPID | Integration Engine: Pipeline-ID | 20041115 |
Method GET_PIPELINE_ID on class CL_XMS_MSG_REF has no exception.
Method GET_PROCESS_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PROCESSID | Value transfer | Type reference (TYPE) | SXMSPROCESSID | Process ID for package processing | 20041115 |
Method GET_PROCESS_ID on class CL_XMS_MSG_REF has no exception.
Method SET_PROCESS_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PROCESS_ID | Call by reference | Type reference (TYPE) | SXMSGUID | GUID für Objekte der Integration Engine | 20041115 |
Method SET_PROCESS_ID on class CL_XMS_MSG_REF has no exception.
Method SET_QUEUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | QUEUE | Call by reference | Type reference (TYPE) | TRFCQNAM | Name einer tRFC-Queue | 20041115 |
Method SET_QUEUE on class CL_XMS_MSG_REF has no exception.
Method UNPACK Signature
Method UNPACK on class CL_XMS_MSG_REF has no parameter.
Method UNPACK on class CL_XMS_MSG_REF has no exception.
Method WRITE_PMAST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | QUEUE | Call by reference | Type reference (TYPE) | TRFCQNAM | Name einer tRFC-Queue | 20041115 | |||
| 2 | TID | Call by reference | Type reference (TYPE) | SXMSREFVAL | eindeutige Transaktions-Id (LUW->COMMIT WORK). | 20041115 |
Method WRITE_PMAST on class CL_XMS_MSG_REF has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 640 |