SAP ABAP Interface IF_SOAP_PAYLOAD (Payload handler)

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 - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SOAP_PAYLOAD	Read and write access on payload	20120703

Properties

Interface	IF_SOAP_PAYLOAD
Short Description	Payload handler

General Data

Package	SOAP_PERSISTENCY	Administration Tools - Translation into DE, EN, FR, JA
Created	20120703	SAP
Last changed	20130531	SAP
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	IF_SOAP_PAYLOAD	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Interface IF_SOAP_PAYLOAD has no interface.

Friends

Interface IF_SOAP_PAYLOAD has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_PAYLOAD_ITEM_FORMAT	Constant	Public	☐	See coding				20120703
2	CO_PAYLOAD_MESSAGE_FORMAT	Constant	Public	☐	See coding				20120703

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ERROR_VERSION	Instance method	Public	Method	Add Error Version to an Existing Message	20120703
2	ADD_MESSAGE_ITEMS	Instance method	Public	Method	Add Messge Items (message did not existed before)	20120703
3	GET_CONTEXT_DATA	Instance method	Public	Method	Get Context Data	20120703
4	GET_MASKED_MESSAGE_PAYLOAD	Instance method	Public	Method	Get Masked Message Payload	20120703
5	GET_MESSAGE_ITEMS	Instance method	Public	Method	Get Messge Items	20120703
6	GET_MESSAGE_PAYLOAD	Instance method	Public	Method	Get Message Payload	20120703
7	SET_MASKED_MESSAGE_PAYLOAD	Instance method	Public	Method	Set Masked Message Payload	20120703
8	SET_MESSAGE_PAYLOAD	Instance method	Public	Method	Set Message Payload	20120703

Events

Interface IF_SOAP_PAYLOAD has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_MESSAGE_CONTEXT	Public	See coding			20120703	BEGIN OF TY_MESSAGE_CONTEXT, soap_application_name TYPE srt_wsp_soap_appl_name, endpoint TYPE prx_r3name, ib_interface TYPE qname, message_type TYPE qname, internal_operation TYPE string, hmac TYPE hash512_raw, rbam_environment TYPE xstring, split_xpath TYPE string, encryption_attr TYPE srt_encryption_attr, END OF TY_MESSAGE_CONTEXT
2	T_ITEM_FORMAT	Public	Type reference (TYPE)	CHAR1		20120703
3	T_MESSAGE_FORMAT	Public	Type reference (TYPE)	CHAR1		20120703

Method Signatures

Method ADD_ERROR_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXPIRY_DATE	Call by reference	☑	Type reference (TYPE)	SYDATUM			20120703
2	Importing	ITEM_LIST	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_ITEM_T			20120703
3	Importing	MESSAGE_STATE	Call by reference	☐	Type reference (TYPE)	SRT_MESSAGE_STATE			20120703
4	Importing	RETENT_CATEGORY	Call by reference	☑	Type reference (TYPE)	SRT_RETENTION_CATEGORY			20120703

Method ADD_ERROR_VERSION on Interface IF_SOAP_PAYLOAD has no exception.

Method ADD_MESSAGE_ITEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENCRYPT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120703
2	Importing	ITEM_LIST	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_ITEM_T			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 Interface IF_SOAP_PAYLOAD has no exception.

Method GET_MASKED_MESSAGE_PAYLOAD Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SOAP_PAYLOAD_ERROR	☐		20120703

Method GET_MESSAGE_ITEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ITEMS	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_ITEM_T			20120703
2	Exporting	EV_ERROR_INDICATOR	Call by reference	☐	Type reference (TYPE)	SRT_ERROR_INDICATOR			20120703
3	Exporting	EV_IS_MASKED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120703
4	Importing	IV_FORMAT	Call by reference	☐	Type reference (TYPE)	T_MESSAGE_FORMAT	CO_PAYLOAD_ITEM_FORMAT-DIRECT_CALL		20120703
5	Importing	IV_LOG_ACCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120703
6	Importing	IV_MASK_SENSITIVE_DATA	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120703
7	Importing	IV_VERSION_OPT	Call by reference	☑	Type reference (TYPE)	SRT_VERSION_OPTION			20120703
8	Importing	IV_VIRUS_CHECK	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120703

#	Exception	Resumable	Description	Created on
1	CX_SOAP_PAYLOAD_ERROR	☐		20120703

Method GET_MESSAGE_PAYLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FORMAT	Call by reference	☐	Type reference (TYPE)	T_MESSAGE_FORMAT	CO_PAYLOAD_MESSAGE_FORMAT-AS_XML		20120703
2	Exporting	PAYLOAD	Call by reference	☐	Type reference (TYPE)	XSTRING			20120703
3	Importing	VIRUS_CHECK	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120703

#	Exception	Resumable	Description	Created on
1	CX_SOAP_PAYLOAD_ERROR	☐		20120703

Method SET_MASKED_MESSAGE_PAYLOAD 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
2	Importing	VIRUS_CHECK	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20120703

#	Exception	Resumable	Description	Created on
1	CX_SOAP_PAYLOAD_ERROR	☐		20120703

Method SET_MESSAGE_PAYLOAD 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
2	Importing	VIRUS_CHECK	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20120703

#	Exception	Resumable	Description	Created on
1	CX_SOAP_PAYLOAD_ERROR	☐		20120703

History

Last changed by/on	SAP	20130531
SAP Release Created in