SAP ABAP Class IF_XMS_PERSIST (Integration Engine: External API)
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | IF_XMS_PERSIST_CONST | Integration Engine: Attributes | 20030904 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_XMS_PERSIST | Persistency Layer for the XML Message Broker | 20020802 |
Properties
| Class | IF_XMS_PERSIST | |
| Short Description | Integration Engine: External API | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20020802 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  CL_XMS_PERSIST |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class IF_XMS_PERSIST has no interface implemented.
Friends
Class IF_XMS_PERSIST has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CO_HANDLE_TYPE_MSGID_DEL |
Instance attribute | Public | Attribute reference (LIKE) | XMS: Handle Type | 20030904 | |||
| 2 | CO_HANDLE_TYPE_TID_DEL |
Instance attribute | Public | Attribute reference (LIKE) | XMS: Handle Type | 20030904 | |||
| 3 | CO_PIPELINE_PE_ADAPTER |
Instance attribute | Public | Attribute reference (LIKE) | XMS: PE_ADAPTER | 20030904 | |||
| 4 | CO_PIPELINE_PE_PROCESS |
Instance attribute | Public | Attribute reference (LIKE) | XMS: PE_PROCESS | 20030904 | |||
| 5 | CO_STAT_ACK_APP_ERROR_FINAL |
Instance attribute | Public | Attribute reference (LIKE) | 20030904 | ||||
| 6 | CO_STAT_ACK_APP_ERROR_TRANS |
Instance attribute | Public | Attribute reference (LIKE) | 20030904 | ||||
| 7 | CO_STAT_ACK_APP_OK |
Instance attribute | Public | Attribute reference (LIKE) | 20030904 | ||||
| 8 | CO_STAT_ACK_NOT_SUPPORTED |
Instance attribute | Public | Attribute reference (LIKE) | 20030904 | ||||
| 9 | CO_STAT_ACK_NOT_YET |
Instance attribute | Public | Attribute reference (LIKE) | 20030904 | ||||
| 10 | CO_STAT_ACK_SYS_BRANCH |
Instance attribute | Public | Attribute reference (LIKE) | 20030904 | ||||
| 11 | CO_STAT_ACK_SYS_ERROR_FINAL |
Instance attribute | Public | Attribute reference (LIKE) | 20030904 | ||||
| 12 | CO_STAT_ACK_SYS_ERROR_TRANS |
Instance attribute | Public | Attribute reference (LIKE) | 20030904 | ||||
| 13 | CO_STAT_ACK_SYS_OK |
Instance attribute | Public | Attribute reference (LIKE) | 20030904 | ||||
| 14 | CO_STAT_ACK_TREE_INCOMPLETE |
Instance attribute | Public | Attribute reference (LIKE) | 20030904 | ||||
| 15 | CO_STAT_ACK_UNDEFINED |
Instance attribute | Public | Attribute reference (LIKE) | 20030904 | ||||
| 16 | CO_STAT_ADAP_ERROR |
Instance attribute | Public | Attribute reference (LIKE) | XMS: Adapter Status 'Contains Errors' | 20030904 | |||
| 17 | CO_STAT_ADAP_PROCESSED |
Instance attribute | Public | Attribute reference (LIKE) | XMS: Adapter Status 'Processed' | 20030904 | |||
| 18 | CO_STAT_ADAP_PROCESSING |
Instance attribute | Public | Attribute reference (LIKE) | XMS: Adapter Status 'Being Processed' | 20030904 | |||
| 19 | CO_STAT_ADAP_RECORDED |
Instance attribute | Public | Attribute reference (LIKE) | XMS: Adapter Status 'Scheduled' | 20030904 | |||
| 20 | CO_STAT_ARCHIVABLE |
Instance attribute | Public | Attribute reference (LIKE) | XMS: Message Flagged for Archiving | 20030904 | |||
| 21 | CO_STAT_DELETABLE |
Instance attribute | Public | Attribute reference (LIKE) | XMS: Message Flagged for Deletion | 20030904 | |||
| 22 | CO_STAT_PROCESSED |
Instance attribute | Public | Attribute reference (LIKE) | XMS: Messaged Processed | 20030904 | |||
| 23 | G_ADAPTER_TYPE |
Instance attribute | Public | Type reference (TYPE) | SXMSPSTYPE | XMS: Adapter Type | 20020823 | ||
| 24 | G_PID_EXT |
Instance attribute | Public | Type reference (TYPE) | SXMSPIDEXT | XMS: Pipeline ID | 20020806 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | INSERT_MESSAGE |
Instance method | Public | Method | Generate message (version) in persistence | 20020802 |
| 2 | INSERT_MESSAGE_ARRAY |
Instance method | Public | Method | Create Message (Version) in Persistence (for AMF) | 20070828 |
| 3 | MESSAGE_EXISTS |
Instance method | Public | Method | Check Whether XI Message Exists | 20111107 |
| 4 | READ_MESSAGE |
Instance method | Public | Method | Read message from persistence | 20020802 |
| 5 | SET_ADAPTER_STATUS |
Instance method | Public | Method | Set adapter status | 20020813 |
| 6 | SET_ADAPTER_STATUS_ARRAY |
Instance method | Public | Method | Sets Adapter Status for a List of Messages | 20070730 |
| 7 | SET_MESSAGE_STATUS |
Instance method | Public | Method | Set message status | 20020813 |
| 8 | SET_MESSAGE_STATUS_ARRAY |
Instance method | Public | Method | Sets Message Status for a List of Messages | 20070730 |
| 9 | SET_QUEUE_INFO |
Instance method | Public | Method | Set Queue Information | 20070307 |
Events
Class IF_XMS_PERSIST has no event.
Types
Class IF_XMS_PERSIST has no local type.
Method Signatures
Method INSERT_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IM_MESSAGE | Call by reference | Object reference (TYPE REF TO) | IF_XMS_MESSAGE_XMB | XMS: XI-Message | 20020813 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_XMS_SYSTEM_ERROR |
XMS: Ausnahmeklasse für Systemfehler | 20020808 |
Method INSERT_MESSAGE_ARRAY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_MMF | Call by reference | Object reference (TYPE REF TO) | IF_XMS_MESSAGE_MMF | Multi message interface | 20070828 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XMS_SYSTEM_ERROR |
XI: Systemfehler | 20070828 |
Method MESSAGE_EXISTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_MESSAGE_ID | Call by reference | Type reference (TYPE) | SXMSMGUID | XI: Message-Id | 20111107 | ||
| 2 |  Returning |
RE_MESSAGE_EXISTS | Value transfer | Type reference (TYPE) | SXMSFLAG | XMS: Flag (true/false) | 20111107 |
Method MESSAGE_EXISTS on class IF_XMS_PERSIST has no exception.
Method READ_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_MESSAGE_ID | Call by reference | Type reference (TYPE) | SXMSMGUID | XMS: Message-Id | 20020813 | ||
| 2 | Returning |
RE_MESSAGE | Value transfer | Object reference (TYPE REF TO) | IF_XMS_MESSAGE_XMB | XMS: XI-Message | 20020813 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XMS_SYSTEM_ERROR |
XMS: Ausnahmeklasse für Systemfehler | 20020808 |
Method SET_ADAPTER_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_MESSAGE | Call by reference | Object reference (TYPE REF TO) | IF_XMS_MESSAGE_XMB | XMS: Message | 20020820 | ||
| 2 | Importing |
IM_MESSAGE_ID | Call by reference | Type reference (TYPE) | SXMSMGUID | XMS: Message-Id | 20020813 | ||
| 3 | Importing |
IM_STATUS | Call by reference | Type reference (TYPE) | SXMSPASTAT | XMS: Adapter-Status | 20020813 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XMS_SYSTEM_ERROR |
XMS: Ausnahmeklasse für Systemfehler | 20020813 |
Method SET_ADAPTER_STATUS_ARRAY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_MESSAGE_ID_ARRAY | Call by reference | Type reference (TYPE) | SXMSMGUIDT | XMS: Message-Id | 20070730 | ||
| 2 | Importing |
IM_PID | Call by reference | Type reference (TYPE) | SXMSPID | 'CENTRAL' | Integration Engine: Pipeline-ID | 20070730 | |
| 3 | Importing |
IM_STATUS | Call by reference | Type reference (TYPE) | SXMSPASTAT | '006' | XMS: Adapter-Status | 20070730 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XMS_SYSTEM_ERROR |
XMS: Ausnahmeklasse für Systemfehler | 20070730 |
Method SET_MESSAGE_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_MESSAGE | Call by reference | Object reference (TYPE REF TO) | IF_XMS_MESSAGE_XMB | XMS: Message | 20020820 | ||
| 2 | Importing |
IM_MESSAGE_ID | Call by reference | Type reference (TYPE) | SXMSMGUID | XMS: Message-Id | 20020813 | ||
| 3 | Importing |
IM_STATUS | Call by reference | Type reference (TYPE) | SXMSPMSTAT | XMS: Status einer Message | 20020813 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XMS_SYSTEM_ERROR |
XMS: Ausnahmeklasse für Systemfehler | 20020813 |
Method SET_MESSAGE_STATUS_ARRAY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_MESSAGE_ID_ARRAY | Call by reference | Type reference (TYPE) | SXMSMGUIDT | XMS: Message-Id | 20070730 | ||
| 2 | Importing |
IM_PID | Call by reference | Type reference (TYPE) | SXMSPID | 'PE_ADAPTER' | Integration Engine: Pipeline-ID | 20070730 | |
| 3 | Importing |
IM_STATUS | Call by reference | Type reference (TYPE) | SXMSPMSTAT | '003' | XMS: Status einer Message | 20070730 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XMS_SYSTEM_ERROR |
XMS: Ausnahmeklasse für Systemfehler | 20070730 |
Method SET_QUEUE_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_EO_REFID | Call by reference | Type reference (TYPE) | SXMSREFID | 'TID' | Integration Engine: Referenz-Typ | 20070307 | |
| 2 | Importing |
IM_EO_REFVAL | Call by reference | Type reference (TYPE) | SXMSREFVAL | Integration Engine: Referenzwert | 20070307 | ||
| 3 | Importing |
IM_MSGGUID | Call by reference | Type reference (TYPE) | SXMSMGUID | XI: Message-Id | 20070307 | ||
| 4 | Importing |
IM_PID | Call by reference | Type reference (TYPE) | SXMSPID | Integration Engine: Pipeline-ID | 20070307 | ||
| 5 | Importing |
IM_QUEUEINT | Call by reference | Type reference (TYPE) | TRFCQNAM | Name einer tRFC-Queue | 20070307 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XMS_SYSTEM_ERROR |
XI: Systemfehler | 20070307 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in |
