SAP ABAP Class CL_WSPROTOCOL_PAYLOAD (Implementation IF_PROXY_PAYLOADS)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ESI-WS-ABA-RT (Application Component) WebServices ABAP Runtime
⤷
SAI_PROXY_RUNTIME_WS_PROTOCOL (Package) ABAP Proxies: WS Protocols
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_WSPROTOCOL | ABAP Proxies: Available Protocols | 20030730 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_WSPROTOCOL_PAYLOAD | XI and WS: Access to Payload | 20030730 |
Properties
| Class | CL_WSPROTOCOL_PAYLOAD | |
| Short Description | Implementation IF_PROXY_PAYLOADS | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SAI_PROXY_RUNTIME_WS_PROTOCOL | ABAP Proxies: WS Protocols |
| Created | 20030730 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_WSPROTOCOL | ABAP Proxies: Available Protocols | 20030730 | ||
| 2 | IF_WSPROTOCOL_PAYLOAD | XI and WS: Access to Payload | 20030730 |
Friends
Class CL_WSPROTOCOL_PAYLOAD has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_WS_PAYLOAD | 20030730 | ||||
| 2 | Instance attribute | Private | Object reference (TYPE REF TO) | CX_AI_SYSTEM_FAULT | buffer for exception during request serialization | 20080121 | |||
| 3 | Instance attribute | Private | Object reference (TYPE REF TO) | CX_AI_SYSTEM_FAULT | buffer for exception during response/fault serialization | 20080121 | |||
| 4 | Instance attribute | Private | Type reference (TYPE) | T_EXTENDED_XML_HANDLING_TAB | 20030730 | ||||
| 5 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_PROXY_FRAMEWORK | Proxy Framework | 20030730 | |||
| 6 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_SXMLP_PART | request part | 20071127 | |||
| 7 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_WS_PAYLOAD | 20030730 | ||||
| 8 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_WS_PAYLOAD | 20030730 | ||||
| 9 | Instance attribute | Private | Type reference (TYPE) | BOOLEAN | TSOAP_FALSE | true, if fault payload shall be supplied | 20080118 | ||
| 10 | Instance attribute | Private | Type reference (TYPE) | BOOLEAN | TSOAP_FALSE | true, if request payload shall be supplied | 20080118 | ||
| 11 | Instance attribute | Private | Type reference (TYPE) | BOOLEAN | TSOAP_FALSE | true, if response payload shall be supplied | 20080118 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | 20030730 | ||
| 2 | Instance method | Public | Method | reads the current values of the payload announcement | 20080204 | |
| 3 | Static method | Public | Method | 20030730 | ||
| 4 | Instance method | Public | Method | serializes the request part | 20080121 | |
| 5 | Instance method | Public | Method | serializes the response part | 20080121 | |
| 6 | Instance method | Public | Method | 20030730 | ||
| 7 | Instance method | Public | Method | sets the request part (is used only on provider side) | 20080122 | |
| 8 | Instance method | Public | Method | 20030730 | ||
| 9 | Instance method | Public | Method | 20030730 |
Events
Class CL_WSPROTOCOL_PAYLOAD has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_EXTENDED_XML_HANDLING | Private | See coding | 20070627 | begin of T_EXTENDED_XML_HANDLING,
method type SEOCMPNAME,
direction type STRING,
value type PRX_XXML,
end of T_EXTENDED_XML_HANDLING
|
||
| 2 | T_EXTENDED_XML_HANDLING_TAB | Private | See coding | 20070627 | T_EXTENDED_XML_HANDLING_TAB type standard table of T_EXTENDED_XML_HANDLING
|
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PROXY_FRAMEWORK | Call by reference | Object reference (TYPE REF TO) | IF_PROXY_FRAMEWORK | Proxy Framework | 20030730 |
Method CONSTRUCTOR on class CL_WSPROTOCOL_PAYLOAD has no exception.
Method GET_PAYLOAD_ANNOUNCEMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | SUPPLY_FAULT | Call by reference | Type reference (TYPE) | BOOLEAN | true if fault shall be supplied | 20080204 | |||
| 2 | SUPPLY_REQUEST | Call by reference | Type reference (TYPE) | BOOLEAN | true if request shall be supplied | 20080204 | |||
| 3 | SUPPLY_RESPONSE | Call by reference | Type reference (TYPE) | BOOLEAN | true if response shall be supplied | 20080204 |
Method GET_PAYLOAD_ANNOUNCEMENT on class CL_WSPROTOCOL_PAYLOAD has no exception.
Method GET_PROTOCOL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PROTOCOL | Value transfer | Object reference (TYPE REF TO) | IF_WSPROTOCOL_PAYLOAD | 20030730 | ||||
| 2 | PROXY_FRAMEWORK | Call by reference | Object reference (TYPE REF TO) | IF_PROXY_FRAMEWORK | Proxy Framework | 20030730 |
Method GET_PROTOCOL on class CL_WSPROTOCOL_PAYLOAD has no exception.
Method SERIALIZE_REQUEST_PART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | REQUEST_PART | Call by reference | Object reference (TYPE REF TO) | IF_SXMLP_PART | request part | 20080121 |
Method SERIALIZE_REQUEST_PART on class CL_WSPROTOCOL_PAYLOAD has no exception.
Method SERIALIZE_RESPONSE_PART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | APPLICATION_FAULT_OCCURRED | Call by reference | Type reference (TYPE) | BOOLEAN | TSOAP_FALSE | true, if an application fault has occurred | 20080122 | ||
| 2 | RESPONSE_PART | Call by reference | Object reference (TYPE REF TO) | IF_SXMLP_PART | response part | 20080121 |
Method SERIALIZE_RESPONSE_PART on class CL_WSPROTOCOL_PAYLOAD has no exception.
Method SET_EXCEPTION_PAYLOAD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EXCEPTION_PAYLOAD | Call by reference | Object reference (TYPE REF TO) | IF_WS_PAYLOAD | 20030730 |
Method SET_EXCEPTION_PAYLOAD on class CL_WSPROTOCOL_PAYLOAD has no exception.
Method SET_REQUEST_PART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | REQUEST_PART | Call by reference | Object reference (TYPE REF TO) | IF_SXMLP_PART | request part | 20080122 |
Method SET_REQUEST_PART on class CL_WSPROTOCOL_PAYLOAD has no exception.
Method SET_REQUEST_PAYLOAD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | REQUEST_PAYLOAD | Call by reference | Object reference (TYPE REF TO) | IF_WS_PAYLOAD | 20030730 |
Method SET_REQUEST_PAYLOAD on class CL_WSPROTOCOL_PAYLOAD has no exception.
Method SET_RESPONSE_PAYLOAD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RESPONSE_PAYLOAD | Call by reference | Object reference (TYPE REF TO) | IF_WS_PAYLOAD | 20030730 |
Method SET_RESPONSE_PAYLOAD on class CL_WSPROTOCOL_PAYLOAD has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 640 |