SAP ABAP Interface IF_SOAP_MESSAGE (Low-Level Message Interface Implemented by Transport Binding)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ESI-WS-ABA-RT (Application Component) WebServices ABAP Runtime
     ⤷ SOAP_CORE (Package) SOAP Runtime: Core SOAP Functionality
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface composition (i COMPRISING i_ref)  IF_SOAP_MESSAGE_11 SOAP 1.1 Message Interface 20021213
2 Interface composition (i COMPRISING i_ref)  IF_SOAP_MESSAGE_12 SOAP 1.2 Message Interface 20080602
3 Interface implementation (CLASS c. INTERFACES i_ref)  CL_SOAP_MESSAGE SOAP Connection to ICF (HTTP) 20021202
4 Interface implementation (CLASS c. INTERFACES i_ref)  CL_SOAP_MESSAGE_NEW SOAP Connection to ICF (HTTP) 20050901
Properties
Interface IF_SOAP_MESSAGE  
Short Description Low-Level Message Interface Implemented by Transport Binding    
General Data
Package SOAP_CORE   SOAP Runtime: Core SOAP Functionality 
Created 20020904   SAP 
Last changed 20141121    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 TSOAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
2 TSXML Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 IF_SOAP_HIBERNATION Hibernate and Wake Runtime Context 20050421
Friends
Interface IF_SOAP_MESSAGE has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CO_SOAP_BDY Instance attribute Public Type reference (TYPE) STRING 20021213
2 CO_SOAP_ENC_NS Instance attribute Public Type reference (TYPE) STRING 20021213
3 CO_SOAP_ENV Instance attribute Public Type reference (TYPE) STRING 20021213
4 CO_SOAP_ENV_NS Instance attribute Public Type reference (TYPE) STRING 20021213
5 CO_SOAP_ENV_PREFIX Instance attribute Public Type reference (TYPE) STRING 20080602
6 CO_SOAP_FAULT Instance attribute Public Type reference (TYPE) STRING 20030121
7 CO_SOAP_FAULT_MUSTUNDERSTAND Instance attribute Public Type reference (TYPE) STRING 20030815
8 CO_SOAP_FAULT_VERSION Instance attribute Public Type reference (TYPE) STRING 20030815
9 CO_SOAP_HDR Instance attribute Public Type reference (TYPE) STRING 20021213
10 CO_SOAP_MUSTUNDERSTAND_ATTR Instance attribute Public Type reference (TYPE) STRING 20030815
11 CO_SOAP_ROLE_ATTR Instance attribute Public Type reference (TYPE) STRING 20030815
12 STYLE Instance attribute Public Type reference (TYPE) TSOAP_MSG_STYLE 20030115
Methods
# Method Level Visibility Method type Description Created on
1 ADD_ATTACHMENT_PART Instance method Public Method Add mime elements to the message 20021212
2 ADD_BODY_FAULT Instance method Public Method Get and Set Fault Element for SOAP Body 20030416
3 ADD_BODY_PART Instance method Public Method Add xml elements to soap body 20021202
4 ADD_CUSTOM_HEADER_PART Instance method Public Method add xml elements to customer header 20090313
5 ADD_FAULT_OBSERVER Instance method Public Method Add Observer for Expected Application Faults 20050920
6 ADD_FAULT_PART Instance method Public Method Add XML Element to List of Expected Application Faults 20030429
7 ADD_HEADER_PART Instance method Public Method Add xml elements to soap header 20021202
8 CONSUME_BODY_INTO_XML_WRITER Instance method Public Method moves (skips) body into XML writer (for signature check) 20100528
9 GET_ATTACHMENT_PART Instance method Public Method Get MIME Attachment 20040812
10 GET_BODY_CHILD Instance method Public Method 20030806
11 GET_BODY_OBSERVER Instance method Public Method 20030806
12 GET_CUSTOM_HDR_PART_COLLECTION Instance method Public Method return the custom header part collection 20090313
13 GET_FAULT_OBSERVERS Instance method Public Method 20120709
14 GET_HEADER_NODES_BY_NMSPC Instance method Public Method Get deseriliazed header nodes for a registered namespace 20110104
15 GET_HEADER_OBSERVER Instance method Public Method 20030806
16 GET_HEADER_PART_COLLECTION Instance method Public Method 20110111
17 GET_PAYLOAD_AS_IS Instance method Public Method 20130829
18 GET_PAYLOAD_XSTRING Instance method Public Method Get payload 20101201
19 GET_SOAP_VERSION Instance method Public Method Get SOAP version 20110105
20 NUM_ATTACHMENT_PARTS Instance method Public Method Returns Number of Attachments 20040827
21 REGISTER_BODY_OBSERVER Instance method Public Method 20030221
22 REGISTER_HEADER_OBSERVER Instance method Public Method 20030221
23 SET_CUSTOM_HDR_PART_COLLECTION Instance method Public Method set custom header part collection to the WS Message 20090313
24 SET_RPC_STYLE Instance method Public Method 20030123
25 UPDATE_HEADER_PART Instance method Public Method Update xml elements to soap header 20080810
Events
Interface IF_SOAP_MESSAGE has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TT_SXMLP_OBSERVER Public See coding 20120709 TT_SXMLP_OBSERVER TYPE STANDARD TABLE OF REF TO if_sxmlp_observer WITH DEFAULT KEY
Method Signatures

Method ADD_ATTACHMENT_PART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PART Call by reference Object reference (TYPE REF TO) IF_MIME_PART war: IF_SOAP_MESSAGE_PART 20021212
# Exception Resumable Description Created on
1 CX_SOAP_NOT_SUPPORTED soap core exception 20021212

Method ADD_BODY_FAULT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning FAULT Value transfer Object reference (TYPE REF TO) IF_SOAP_FAULT 20030416

Method ADD_BODY_FAULT on Interface IF_SOAP_MESSAGE has no exception.

Method ADD_BODY_PART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PART Call by reference Object reference (TYPE REF TO) IF_SXMLP_PART_ABSTRACT abstract SXML/SXMLP part 20021211

Method ADD_BODY_PART on Interface IF_SOAP_MESSAGE has no exception.

Method ADD_CUSTOM_HEADER_PART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing MUST_UNDERSTAND Call by reference Type reference (TYPE) BOOLEAN 20090313
2 Importing PART Call by reference Object reference (TYPE REF TO) IF_SXMLP_PART_ABSTRACT Interface for SOAP Parts 20090313

Method ADD_CUSTOM_HEADER_PART on Interface IF_SOAP_MESSAGE has no exception.

Method ADD_FAULT_OBSERVER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing OBSERVER Call by reference Object reference (TYPE REF TO) IF_SXMLP_OBSERVER 20050920

Method ADD_FAULT_OBSERVER on Interface IF_SOAP_MESSAGE has no exception.

Method ADD_FAULT_PART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PART Call by reference Object reference (TYPE REF TO) IF_SXMLP_PART_ABSTRACT abstract SXML/SXMLP part 20030429

Method ADD_FAULT_PART on Interface IF_SOAP_MESSAGE has no exception.

Method ADD_HEADER_PART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing MUST_UNDERSTAND Call by reference Type reference (TYPE) BOOLEAN 20030815
2 Importing PART Call by reference Object reference (TYPE REF TO) IF_SXMLP_PART_ABSTRACT interface for soap parts 20021202

Method ADD_HEADER_PART on Interface IF_SOAP_MESSAGE has no exception.

Method CONSUME_BODY_INTO_XML_WRITER Signature

Method CONSUME_BODY_INTO_XML_WRITER on Interface IF_SOAP_MESSAGE has no parameter.
Method CONSUME_BODY_INTO_XML_WRITER on Interface IF_SOAP_MESSAGE has no exception.

Method GET_ATTACHMENT_PART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID Call by reference Type reference (TYPE) STRING content ID of MIME attachment 20040824
2 Importing INDEX Call by reference Type reference (TYPE) I index of MIME attachment 20040812
3 Returning PART Value transfer Object reference (TYPE REF TO) IF_MIME_PART MIME attachment part 20040812

Method GET_ATTACHMENT_PART on Interface IF_SOAP_MESSAGE has no exception.

Method GET_BODY_CHILD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning NAME Value transfer Type reference (TYPE) QNAME 20030806

Method GET_BODY_CHILD on Interface IF_SOAP_MESSAGE has no exception.

Method GET_BODY_OBSERVER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning OBSERVER Value transfer Object reference (TYPE REF TO) IF_SXMLP_OBSERVER_ABSTRACT abstract SXML/SXMLP observer 20030806

Method GET_BODY_OBSERVER on Interface IF_SOAP_MESSAGE has no exception.

Method GET_CUSTOM_HDR_PART_COLLECTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CUSTOM_HDR_PART_COLLECTION Value transfer Object reference (TYPE REF TO) IF_SXMLP_PART_COLLECTION 20090313

Method GET_CUSTOM_HDR_PART_COLLECTION on Interface IF_SOAP_MESSAGE has no exception.

Method GET_FAULT_OBSERVERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_FAULT_OBSERVER Value transfer Type reference (TYPE) IF_SOAP_MESSAGE=>TT_SXMLP_OBSERVER 20120709

Method GET_FAULT_OBSERVERS on Interface IF_SOAP_MESSAGE has no exception.

Method GET_HEADER_NODES_BY_NMSPC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting HEADER_NODES Call by reference Type reference (TYPE) SRT_HEADER_NODE_TAB deserilaized header nodes 20110104
2 Importing NAMESPACE Call by reference Type reference (TYPE) ANYURI Namespace 20110104

Method GET_HEADER_NODES_BY_NMSPC on Interface IF_SOAP_MESSAGE has no exception.

Method GET_HEADER_OBSERVER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning OBSERVER Value transfer Object reference (TYPE REF TO) IF_SXMLP_OBSERVER_ABSTRACT abstract SXML/SXMLP observer 20030806

Method GET_HEADER_OBSERVER on Interface IF_SOAP_MESSAGE has no exception.

Method GET_HEADER_PART_COLLECTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing QNAME Call by reference Type reference (TYPE) QNAME 20110111
2 Returning RVAL Value transfer Object reference (TYPE REF TO) IF_SXMLP_PART_COLLECTION 20110111

Method GET_HEADER_PART_COLLECTION on Interface IF_SOAP_MESSAGE has no exception.

Method GET_PAYLOAD_AS_IS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_XOP_PART Call by reference Type reference (TYPE) IF_SXML_XOP=>XOP_PARTS 20130829
2 Exporting EV_XSTRING Call by reference Type reference (TYPE) XSTRING 20130829

Method GET_PAYLOAD_AS_IS on Interface IF_SOAP_MESSAGE has no exception.

Method GET_PAYLOAD_XSTRING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_XSTRING Value transfer Type reference (TYPE) XSTRING 20101201

Method GET_PAYLOAD_XSTRING on Interface IF_SOAP_MESSAGE has no exception.

Method GET_SOAP_VERSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_SOAP_VERSION Value transfer Type reference (TYPE) STRING 20110105

Method GET_SOAP_VERSION on Interface IF_SOAP_MESSAGE has no exception.

Method NUM_ATTACHMENT_PARTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning NUM Value transfer Type reference (TYPE) INT4 number of attachments 20040827

Method NUM_ATTACHMENT_PARTS on Interface IF_SOAP_MESSAGE has no exception.

Method REGISTER_BODY_OBSERVER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing OBSERVER Call by reference Object reference (TYPE REF TO) IF_SXMLP_OBSERVER_ABSTRACT abstract SXML/SXMLP observer 20030221

Method REGISTER_BODY_OBSERVER on Interface IF_SOAP_MESSAGE has no exception.

Method REGISTER_HEADER_OBSERVER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing OBSERVER Call by reference Object reference (TYPE REF TO) IF_SXMLP_OBSERVER_ABSTRACT abstract SXML/SXMLP observer 20030221

Method REGISTER_HEADER_OBSERVER on Interface IF_SOAP_MESSAGE has no exception.

Method SET_CUSTOM_HDR_PART_COLLECTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CUSTOM_HDR_PART_COLLECTION Call by reference Object reference (TYPE REF TO) IF_SXMLP_PART_COLLECTION 20090313

Method SET_CUSTOM_HDR_PART_COLLECTION on Interface IF_SOAP_MESSAGE has no exception.

Method SET_RPC_STYLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing METHOD Call by reference Type reference (TYPE) QNAME Qualified Name 20030123
2 Returning PART Value transfer Object reference (TYPE REF TO) IF_SXMLP_PART_ABSTRACT abstract SXML/SXMLP part 20030123

Method SET_RPC_STYLE on Interface IF_SOAP_MESSAGE has no exception.

Method UPDATE_HEADER_PART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_UPDATED_PART Call by reference Object reference (TYPE REF TO) IF_SXMLP_PART_ABSTRACT Abstract SXML/SXMLP Part 20080811
2 Importing IV_QNAME Call by reference Type reference (TYPE) QNAME 20080811

Method UPDATE_HEADER_PART on Interface IF_SOAP_MESSAGE has no exception.
History
Last changed by/on SAP  20141121 
SAP Release Created in 630