SAP ABAP Class CL_SOAP_EVENTING_API (APIs for external components)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ESI-WS-ABA-RT (Application Component) WebServices ABAP Runtime
⤷
SOAP_EVENT (Package) Package for WS Eventing
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_SOAP_EVENTING_API_INTERNAL | APIs for internal components | 20130801 |
Properties
| Class | CL_SOAP_EVENTING_API | |
| Short Description | APIs for external components | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SOAP_EVENT | Package for WS Eventing |
| Created | 20081125 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_SOAP_EVENTING_API has no forward declaration.
Interfaces
Class CL_SOAP_EVENTING_API has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_SRT_WSP_API_HELPER | 20081216 | Web Administration Help Methods |
Attributes
Class CL_SOAP_EVENTING_API has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | 20130610 | ||
| 2 | Static method | Public | Method | cleanup finished event entries | 20081219 | |
| 3 | Static method | Public | Method | receive payload of event message | 20081208 | |
| 4 | Static method | Public | Method | get an overview about one event | 20081219 | |
| 5 | Static method | Public | Method | get bgrfc queue name by a given msg id | 20090224 | |
| 6 | Static method | Private | Method | is a given LP in use by a persisted subscription list? | 20081204 | |
| 7 | Static method | Public | Method | navigate to the RFC queue by a given message ID | 20090205 | |
| 8 | Static method | Private | Method | remove a logical port from all persisted subscription lists | 20081204 | |
| 9 | Static method | Public | Method | restart a parent event message | 20081125 |
Events
Class CL_SOAP_EVENTING_API has no event.
Types
Class CL_SOAP_EVENTING_API has no local type.
Method Signatures
Method CANCEL_PARENT_EVENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MSG_ID | Call by reference | Type reference (TYPE) | SXMSGUID | 20130610 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20130610 |
Method CLEANUP_PROCESSED_EVENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_GUID_TABLE | Call by reference | Type reference (TYPE) | TTAB_SYSUUID | table type for sysuuid | 20090224 |
Method CLEANUP_PROCESSED_EVENTS on class CL_SOAP_EVENTING_API has no exception.
Method GET_EVENT_PAYLOAD_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_MSG_ID | Call by reference | Type reference (TYPE) | SXMSGUID | GUID for Integration Engine Objects | 20081208 | |||
| 2 | I_PIPELINE | Call by reference | Type reference (TYPE) | SXMSPID | Integration Engine: Pipeline ID | 20081208 | |||
| 3 | PAYLOAD | Value transfer | Type reference (TYPE) | STRING | message payload | 20081208 | |||
| 4 | VERSION | Call by reference | Type reference (TYPE) | SXMSLSQNBR | Sequence Number for a Message Log ID | 20081208 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | exception class for Eventing | 20120105 |
Method GET_OVERVIEW_OF_EVENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_MSGGUID | Call by reference | Type reference (TYPE) | SXMSGUID | GUID for Integration Engine Objects | 20081219 | |||
| 2 | R_STATUS_TABLE | Value transfer | Type reference (TYPE) | TTAB_SRT_EVENTS | table type of srt_events | 20081219 |
Method GET_OVERVIEW_OF_EVENT on class CL_SOAP_EVENTING_API has no exception.
Method GET_QUEUENAME_BY_MSGID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_MSG_ID | Call by reference | Type reference (TYPE) | SXMSGUID | GUID for Integration Engine Objects | 20090224 | |||
| 2 | RE_QUEUE_NAME | Value transfer | Type reference (TYPE) | QRFC_QUEUE_NAME | 20090224 |
Method GET_QUEUENAME_BY_MSGID on class CL_SOAP_EVENTING_API has no exception.
Method IS_EVENT_LP_IN_USE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EVENT_PROXY | Call by reference | Type reference (TYPE) | SRT_LP_PROXYCLASS | Proxy Class of Logical Port | 20081204 | |||
| 2 | IS_USED | Value transfer | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20081204 | |||
| 3 | LOGICAL_PORT | Call by reference | Type reference (TYPE) | SRT_LP_NAME | Logical Port Name | 20081204 |
Method IS_EVENT_LP_IN_USE on class CL_SOAP_EVENTING_API has no exception.
Method NAVIGATE_QUEUE_BY_MSG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_MSGGUID | Call by reference | Type reference (TYPE) | SXMSGUID | GUID for Integration Engine Objects | 20090205 |
Method NAVIGATE_QUEUE_BY_MSG on class CL_SOAP_EVENTING_API has no exception.
Method REMOVE_EVENT_LP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EVENT_PROXY | Call by reference | Type reference (TYPE) | SRT_LP_PROXYCLASS | Proxy Class of Logical Port | 20081204 | |||
| 2 | LOGICAL_PORT | Call by reference | Type reference (TYPE) | SRT_LP_NAME | Logical Port Name | 20081204 |
Method REMOVE_EVENT_LP on class CL_SOAP_EVENTING_API has no exception.
Method RESTART_PARENT_EVENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MSG_ID | Call by reference | Type reference (TYPE) | SXMSGUID | GUID for Integration Engine Objects | 20081125 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | exception class for Eventing | 20081125 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 720 |