SAP ABAP Class CL_SOAP_PAYLOAD (Read and write access on payload)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ESI-WS-ABA-RT (Application Component) WebServices ABAP Runtime
     ⤷ SOAP_PERSISTENCY (Package) Administration Tools - Translation into DE, EN, FR, JA

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SOAP_PAYLOAD_BASIC	Payload utilities	20120703
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SOAP_PAYLOAD	Payload handler	20120703

Properties

Class	CL_SOAP_PAYLOAD
Short Description	Read and write access on payload
Super Class	CL_SOAP_PAYLOAD_BASIC	Payload utilities
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SOAP_PERSISTENCY	Administration Tools - Translation into DE, EN, FR, JA
Created	20120703	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)
2	CL_SOAP_PERSISTENCY_RUNTIME	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_SOAP_PAYLOAD	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	IF_SOAP_PERSISTENCY_CONSTANTS	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
5	TSRC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SOAP_PAYLOAD	☐	☐	Payload handler	20120703

Friends

Class CL_SOAP_PAYLOAD has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_CONTEXT_NAME_700	Static Attribute	Private	☐	Type reference (TYPE)	STRING	IF_SOAP_PERSISTENCY_CONSTANTS=>CO_ATTR_NAME_CONTEXT		20120705
2	CO_CONTEXT_NAME_72L	Static Attribute	Private	☐	Type reference (TYPE)	STRING	IF_SOAP_PERSISTENCY_CONSTANTS=>CO_ATTR_NAME_PERSIST_CONTEXT		20120705
3	CO_CONTEXT_URI_700	Static Attribute	Private	☐	Type reference (TYPE)	STRING	TSRC_SOAP_CONTEXT		20120705
4	CO_CONTEXT_URI_72L	Static Attribute	Private	☐	Type reference (TYPE)	STRING	TSRC_SOAP_PERSISTENCY_CONTEXT		20120705
5	CO_INDEX_DC_FIRST_ATT	Constant	Private	☐	Type reference (TYPE)	I	2		20120703
6	CO_INDEX_DC_PAYLOAD	Constant	Private	☐	Type reference (TYPE)	I	1		20120703
7	CO_INDEX_EVENTING_PAYLOAD	Constant	Private	☐	Type reference (TYPE)	I	1		20120703
8	CO_INDEX_OLD_FIRST_ATT	Constant	Private	☐	Type reference (TYPE)	I	4		20120703
9	CO_INDEX_OLD_PAYLOAD	Constant	Private	☐	Type reference (TYPE)	I	3		20120703
10	MR_PERSISTENCY_RUNTIME	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SOAP_PERSISTENCY_RUNTIME		Persistency runtime	20120704
11	MT_ITEMS	Instance attribute	Private	☐	Type reference (TYPE)	TT_ITEM			20120703
12	MT_RAW_ITEMS	Instance attribute	Private	☐	Type reference (TYPE)	SRT_PERSISTENCY_ITEM_T			20120703
13	MV_ADAPTER_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	SRT_ADAPTER_TYPE			20120703
14	MV_CONTEXT_DATA	Instance attribute	Private	☐	Type reference (TYPE)	IF_SOAP_PAYLOAD=>TY_MESSAGE_CONTEXT			20120703
15	MV_EVENTING	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20120703
16	MV_IS_DIRECT_CALL	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20120703
17	MV_PAYLOAD	Instance attribute	Private	☐	Type reference (TYPE)	XSTRING			20120703
18	MV_RAW_VERS	Instance attribute	Private	☐	Type reference (TYPE)	SRT_MESSAGE_VERSION			20120703

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_PAYLOAD_VERSION	Instance method	Private	Method	Add version data	20120703
2	ASSERT_FORMAT	Instance method	Private	Method		20120703
3	CONSTRUCTOR	Instance method	Private	Constructor	CONSTRUCTOR	20120703
4	GET_CONTEXT_DATA	Instance method	Private	Method		20120703
5	GET_CONTEXT_INTERNAL	Instance method	Private	Method		20120705
6	GET_RAW_ITEMS	Instance method	Private	Method		20120703
7	GET_RAW_ITEMS_LEGACY	Instance method	Private	Method		20120703
8	INIT_PAYLOAD	Instance method	Private	Method		20120703
9	OPEN	Static method	Public	Method	Get IF_SOAP_PAYLOAD	20120703
10	REMOVE_ROOT_TAG	Static method	Private	Method		20120703

Events

Class CL_SOAP_PAYLOAD has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_CONTEXT	Private	See coding			20120703	BEGIN OF ts_context, persist_id TYPE srt_persistency_persist_id, context_data TYPE if_soap_payload=>ty_message_context, END OF ts_context
2	TS_ITEM	Private	See coding			20120703	BEGIN OF ts_item, version_no TYPE srt_message_version, error_vers TYPE srt_error_indicator, format TYPE if_soap_payload=>t_message_format, items TYPE srt_persistency_item_t, END OF ts_item
3	TS_SOAP_PAYLOAD	Private	See coding			20120703	BEGIN OF ts_soap_payload, persist_id TYPE srt_persistency_persist_id, instance TYPE REF TO if_soap_payload, END OF ts_soap_payload
4	TT_CONTEXT_DATA	Private	See coding			20120703	tt_context_data TYPE SORTED TABLE OF ts_context WITH UNIQUE KEY persist_id
5	TT_ITEM	Private	See coding			20120703	tt_item TYPE SORTED TABLE OF ts_item WITH UNIQUE KEY version_no format
6	TT_SOAP_PAYLOAD	Private	See coding			20120703	tt_soap_payload TYPE SORTED TABLE OF ts_soap_payload WITH UNIQUE KEY persist_id

Method Signatures

Method ADD_PAYLOAD_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PAYLOAD	Call by reference	☐	Type reference (TYPE)	XSTRING			20120703

#	Exception	Resumable	Description	Created on
1	CX_SOAP_PAYLOAD_ERROR	☐		20120703

Method ASSERT_FORMAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM_LIST	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_ITEM_T			20120703

Method ASSERT_FORMAT on class CL_SOAP_PAYLOAD has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PERSISTENCY_RUNTIME	Call by reference	☑	Object reference (TYPE REF TO)	IF_SOAP_PERSISTENCY_RUNTIME		Persistency runtime	20120704
2	Importing	PERSIST_ID	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_PERSIST_ID			20120703

#	Exception	Resumable	Description	Created on
1	CX_SOAP_PAYLOAD_ERROR	☐		20120703

Method GET_CONTEXT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CONTEXT_DATA	Value transfer	☐	Type reference (TYPE)	IF_SOAP_PAYLOAD=>TY_MESSAGE_CONTEXT			20120703

Method GET_CONTEXT_DATA on class CL_SOAP_PAYLOAD has no exception.

Method GET_CONTEXT_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ITEM	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_ITEM_T		Persistency Item - Table	20120705
2	Returning	RS_SERVER_CONTEXT	Value transfer	☐	Type reference (TYPE)	IF_SOAP_PERSISTENCY_RUNTIME=>TY_PERSISTENCY_CONTEXT_SERVER			20120705

Method GET_CONTEXT_INTERNAL on class CL_SOAP_PAYLOAD has no exception.

Method GET_RAW_ITEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FORMAT	Call by reference	☐	Type reference (TYPE)	IF_SOAP_PAYLOAD=>T_MESSAGE_FORMAT			20120703
2	Importing	IV_VERSION_OPT	Call by reference	☑	Type reference (TYPE)	SRT_VERSION_OPTION			20120703

#	Exception	Resumable	Description	Created on
1	CX_SOAP_PAYLOAD_ERROR	☐		20120703

Method GET_RAW_ITEMS_LEGACY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FORMAT	Call by reference	☐	Type reference (TYPE)	IF_SOAP_PAYLOAD=>T_MESSAGE_FORMAT			20120703
2	Importing	IV_VERSION_OPT	Call by reference	☑	Type reference (TYPE)	SRT_VERSION_OPTION			20120703

#	Exception	Resumable	Description	Created on
1	CX_SOAP_PAYLOAD_ERROR	☐		20120703

Method INIT_PAYLOAD Signature

Method INIT_PAYLOAD on class CL_SOAP_PAYLOAD has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SOAP_PAYLOAD_ERROR	☐		20120703

Method OPEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PAYLOAD_HANDLER	Value transfer	☐	Object reference (TYPE REF TO)	IF_SOAP_PAYLOAD			20120703
2	Importing	PERSISTENCY_RUNTIME	Call by reference	☑	Object reference (TYPE REF TO)	IF_SOAP_PERSISTENCY_RUNTIME		Persistency runtime	20120704
3	Importing	PERSIST_ID	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_PERSIST_ID			20120703

#	Exception	Resumable	Description	Created on
1	CX_SOAP_PAYLOAD_ERROR	☐		20120703

Method REMOVE_ROOT_TAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PAYLOAD	Call by reference	☐	Type reference (TYPE)	XSTRING			20120703
2	Returning	RV_PAYLOAD	Value transfer	☐	Type reference (TYPE)	XSTRING			20120703

Method REMOVE_ROOT_TAG on class CL_SOAP_PAYLOAD has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	740