SAP ABAP Interface IF_XMS_MESSAGE (XI: Internal Message Interface)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-XI-IS-IEN (Application Component) Integration Engine
     ⤷ SXMSMSG (Package) XI: Message Handling
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_XMS_MESSAGE CL_XMS_MESSAGE 20010528
Properties
Interface IF_XMS_MESSAGE  
Short Description XI: Internal Message Interface    
General Data
Package SXMSMSG   XI: Message Handling 
Created 20010523   SAP 
Last changed 20110908   SAP 
Unicode checks active    
Forward declarations
Interface IF_XMS_MESSAGE has no forward declaration.
Interfaces
Interface IF_XMS_MESSAGE has no interface.
Friends
Interface IF_XMS_MESSAGE has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 AO Instance attribute Public Object reference (TYPE REF TO) CL_XMS_MSGHDR30_ACK Ack Header 20030910
2 DEBUG Instance attribute Public Type reference (TYPE) STRING 20030917
3 DG Instance attribute Public Object reference (TYPE REF TO) CL_XMS_MSGHDR30_DIAGNOSTICS Diagnostics Header 20031007
4 DY Instance attribute Public Object reference (TYPE REF TO) CL_XMS_MSGHDR30_DYNAMIC XI: Dynamic SOAP Header 20050801
5 EO Instance attribute Public Object reference (TYPE REF TO) CL_XMS_MSGHDR30_ERROR Error Header 20030910
6 HLO Instance attribute Public Object reference (TYPE REF TO) CL_XMS_MSGHDR30_HOPLIST Hop List Header 20030910
7 HO Instance attribute Public Object reference (TYPE REF TO) CL_XMS_MSGHDR30_MAIN Main Header 20030910
8 IN_BIND Instance attribute Public Object reference (TYPE REF TO) CL_SRV_BINDING XI Services: Inbound and Outbound Binding 20051107
9 MOINT_RECEIVER_RESPONSE Instance attribute Public Object reference (TYPE REF TO) IF_XMS_MESSAGE 20030919
10 MOINT_SENDER_REQUEST Instance attribute Public Object reference (TYPE REF TO) IF_XMS_MESSAGE 20030919
11 OUTB Instance attribute Public Object reference (TYPE REF TO) IF_SRV_OUTBINDING_XMS_PROP XI Services: XMS Property Container for Outbound Binding 20051216
12 PFO Instance attribute Public Object reference (TYPE REF TO) CL_XMS_RUN_TIME_PERF Performance Header 20030922
13 RM Instance attribute Public Object reference (TYPE REF TO) CL_XMS_MSGHDR30_RM Reliable Messaging Header 20030910
14 RO Instance attribute Public Object reference (TYPE REF TO) CL_XMS_RUN_TIME_ENV Runtime Header 20030910
15 SYS Instance attribute Public Object reference (TYPE REF TO) CL_XMS_MSGHDR30_SYSTEM XI: System SOAP Header 20060220
16 TO Instance attribute Public Object reference (TYPE REF TO) IF_XMS_TRACE Trace 20030922
17 _PAYLOAD_CHANGED Instance attribute Public Type reference (TYPE) CHAR1 Single-Character Flag 20050317
Methods
# Method Level Visibility Method type Description Created on
1 ADDATTACHMENT Instance method Public Method Appends Resource 20011203
2 ADDBODY Instance method Public Method Sets Body Property 20011203
3 ADDHEADER Instance method Public Method Sets Header Property 20011203
4 CLEARATTACHMENTS Instance method Public Method Deletes All Attachment Resources 20011203
5 CLEARBODIES Instance method Public Method Deletes All Body Properties 20011203
6 CLEARHEADERS Instance method Public Method Deletes All Header Properties 20011203
7 CLEAR_PAYLOAD_CHANGED_FLAG Instance method Public Method Reset PAYLOAD_CHANGED Indicator 20050317
8 DELETEATTACHMENTATINDEX Instance method Public Method Deletes Attachment Resource with Index 20011203
9 DELETEATTACHMENTBYNAME Instance method Public Method Deletes Attachment Resource with Name 20011203
10 DELETEBODYATINDEX Instance method Public Method Deletes Body Property with Index 20011203
11 DELETEBODYBYNAME Instance method Public Method Deletes Body Property with Name 20011203
12 DELETEHEADERATINDEX Instance method Public Method Deletes Header Property with Index 20011203
13 DELETEHEADERBYNAME Instance method Public Method Deletes Header Property with Name 20011203
14 GETATTACHMENTATINDEX Instance method Public Method Gets Attachment with Index 20011203
15 GETATTACHMENTBYNAME Instance method Public Method Gets Attachment with Name 20011203
16 GETATTACHMENTS Instance method Public Method Gets Number of Attachment Resources 20011203
17 GETATTACHMENTSBYTYPE Instance method Public Method Gets Type Attachments 20030716
18 GETBODIES Instance method Public Method Gets All Body Properties 20011203
19 GETBODYATINDEX Instance method Public Method Gets Body Property with Index 20011203
20 GETBODYBYNAME Instance method Public Method Gets Body Property with Name 20011203
21 GETBODYNSCONTEXT Instance method Public Method Gets Namespace Context for Body Part 20011203
22 GETHEADERATINDEX Instance method Public Method Get Header Property with Index 20011203
23 GETHEADERBYNAME Instance method Public Method Gets Header Property with Name 20011203
24 GETHEADERNSCONTEXT Instance method Public Method Gets Namespace Context for Header Part 20011203
25 GETHEADERS Instance method Public Method Gets All Header Properties 20011203
26 GET_LOGGING_STATUS Instance method Public Method 20051207
27 GET_READ_FROM_SHM Instance method Public Method 20081111
28 GET_VERSION Instance method Public Method 20030919
29 INSERTATTACHMENT Instance method Public Method Inserts Resource into Index 20011203
30 INSERTBODY Instance method Public Method Inserts Body Property 20011203
31 INSERTHEADER Instance method Public Method Inserts Header Property 20011203
32 MODIFY_ERR_HEADER_FROM_EXCEPT Instance method Public Method Fills or replaces error header with exception data 20051214
33 NUMBEROFATTACHMENTS Instance method Public Method Gets Number of Attachment Resources 20011203
34 NUMBEROFBODIES Instance method Public Method Gets Number of Body Properties 20011203
35 NUMBEROFHEADERS Instance method Public Method Gets Number of Header Properties 20011203
36 PAYLOAD_CHANGED Instance method Public Method Payload changed? 20050317
37 SETBODYNSCONTEXT Instance method Public Method Sets Namespace Context for Body Part 20011203
38 SETHEADERNSCONTEXT Instance method Public Method Sets Namespace Context for Header Part 20011203
39 SETUP_TRACE_LEVEL Instance method Public Method Set Trace Level 20051220
40 SET_READ_FROM_SHM Instance method Public Method 20081111
Events
Interface IF_XMS_MESSAGE has no event.
Types
Interface IF_XMS_MESSAGE has no local type.
Method Signatures

Method ADDATTACHMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Call by reference Type reference (TYPE) STRING Name der Ressource 20011203
2 Importing RESOURCE Call by reference Object reference (TYPE REF TO) IF_XMS_RESOURCE Ressource im Inhalt 20011203

Method ADDATTACHMENT on Interface IF_XMS_MESSAGE has no exception.

Method ADDBODY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LCNAME Call by reference Type reference (TYPE) STRING lokaler Name 20011203
2 Importing NSURI Call by reference Type reference (TYPE) STRING Namespace URI 20011203
3 Importing PROP Call by reference Object reference (TYPE REF TO) IF_XMS_PROP in einen String serialisierbare Property 20011203

Method ADDBODY on Interface IF_XMS_MESSAGE has no exception.

Method ADDHEADER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LCNAME Call by reference Type reference (TYPE) STRING lokaler Name 20011203
2 Importing NSURI Call by reference Type reference (TYPE) STRING Namespace URI 20011203
3 Importing PROP Call by reference Object reference (TYPE REF TO) IF_XMS_PROP in einen String serialisierbare Property 20011203

Method ADDHEADER on Interface IF_XMS_MESSAGE has no exception.

Method CLEARATTACHMENTS Signature

Method CLEARATTACHMENTS on Interface IF_XMS_MESSAGE has no parameter.
Method CLEARATTACHMENTS on Interface IF_XMS_MESSAGE has no exception.

Method CLEARBODIES Signature

Method CLEARBODIES on Interface IF_XMS_MESSAGE has no parameter.
Method CLEARBODIES on Interface IF_XMS_MESSAGE has no exception.

Method CLEARHEADERS Signature

Method CLEARHEADERS on Interface IF_XMS_MESSAGE has no parameter.
Method CLEARHEADERS on Interface IF_XMS_MESSAGE has no exception.

Method CLEAR_PAYLOAD_CHANGED_FLAG Signature

Method CLEAR_PAYLOAD_CHANGED_FLAG on Interface IF_XMS_MESSAGE has no parameter.
Method CLEAR_PAYLOAD_CHANGED_FLAG on Interface IF_XMS_MESSAGE has no exception.

Method DELETEATTACHMENTATINDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INDEX Call by reference Type reference (TYPE) INT4 index 20011203

Method DELETEATTACHMENTATINDEX on Interface IF_XMS_MESSAGE has no exception.

Method DELETEATTACHMENTBYNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Call by reference Type reference (TYPE) STRING Name (identifier) 20011203

Method DELETEATTACHMENTBYNAME on Interface IF_XMS_MESSAGE has no exception.

Method DELETEBODYATINDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INDEX Call by reference Type reference (TYPE) STRING index 20011203

Method DELETEBODYATINDEX on Interface IF_XMS_MESSAGE has no exception.

Method DELETEBODYBYNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LCNAME Call by reference Type reference (TYPE) STRING lokaler Name 20011203
2 Importing NSURI Call by reference Type reference (TYPE) STRING Namespace URI 20011203

Method DELETEBODYBYNAME on Interface IF_XMS_MESSAGE has no exception.

Method DELETEHEADERATINDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INDEX Call by reference Type reference (TYPE) STRING index 20011203

Method DELETEHEADERATINDEX on Interface IF_XMS_MESSAGE has no exception.

Method DELETEHEADERBYNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LCNAME Call by reference Type reference (TYPE) STRING lokaler Name 20011203
2 Importing NSURI Call by reference Type reference (TYPE) STRING Namespace URI 20011203

Method DELETEHEADERBYNAME on Interface IF_XMS_MESSAGE has no exception.

Method GETATTACHMENTATINDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INDEX Call by reference Type reference (TYPE) INT4 Natürliche Zahl 20011203
2 Returning RESOURCE Value transfer Object reference (TYPE REF TO) IF_XMS_RESOURCE Interface für Message Inhalt Ressource 20011203

Method GETATTACHMENTATINDEX on Interface IF_XMS_MESSAGE has no exception.

Method GETATTACHMENTBYNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Call by reference Type reference (TYPE) STRING 20011203
2 Returning RESOURCE Value transfer Object reference (TYPE REF TO) IF_XMS_RESOURCE Interface für Message Inhalt Ressource 20011203

Method GETATTACHMENTBYNAME on Interface IF_XMS_MESSAGE has no exception.

Method GETATTACHMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESOURCES Value transfer Object reference (TYPE REF TO) SXMS_REI_T Tabelle von Ressourcen 20011203

Method GETATTACHMENTS on Interface IF_XMS_MESSAGE has no exception.

Method GETATTACHMENTSBYTYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESOURCES Value transfer Type reference (TYPE) SXMS_REI_T Tabelle von Resourcen 20030716
2 Importing TYPE Call by reference Type reference (TYPE) SXMSPAYLOADTYPE Typ einer Ressource 20030716

Method GETATTACHMENTSBYTYPE on Interface IF_XMS_MESSAGE has no exception.

Method GETBODIES Signature

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

Method GETBODIES on Interface IF_XMS_MESSAGE has no exception.

Method GETBODYATINDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INDEX Call by reference Type reference (TYPE) STRING index 20011203
2 Returning PROP Value transfer Object reference (TYPE REF TO) IF_XMS_PROP in einen String serialisierbare Property 20011203

Method GETBODYATINDEX on Interface IF_XMS_MESSAGE has no exception.

Method GETBODYBYNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LCNAME Call by reference Type reference (TYPE) STRING lokaler Name 20011203
2 Importing NSURI Call by reference Type reference (TYPE) STRING Namespace URI 20011203
3 Returning PROP Value transfer Object reference (TYPE REF TO) IF_XMS_PROP in einen String serialisierbare Property 20011203

Method GETBODYBYNAME on Interface IF_XMS_MESSAGE has no exception.

Method GETBODYNSCONTEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CONTEXT Value transfer Object reference (TYPE REF TO) IF_XMS_NSCONTEXT Namespace Context 20011203

Method GETBODYNSCONTEXT on Interface IF_XMS_MESSAGE has no exception.

Method GETHEADERATINDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INDEX Call by reference Type reference (TYPE) STRING index 20011203
2 Returning PROP Value transfer Object reference (TYPE REF TO) IF_XMS_PROP in einen String serialisierbare Property 20011203

Method GETHEADERATINDEX on Interface IF_XMS_MESSAGE has no exception.

Method GETHEADERBYNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LCNAME Call by reference Type reference (TYPE) STRING lokaler Name 20011203
2 Importing NSURI Call by reference Type reference (TYPE) STRING Namespace URI 20011203
3 Returning PROP Value transfer Object reference (TYPE REF TO) IF_XMS_PROP in einen String serialisierbare Property 20011203

Method GETHEADERBYNAME on Interface IF_XMS_MESSAGE has no exception.

Method GETHEADERNSCONTEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CONTEXT Value transfer Object reference (TYPE REF TO) IF_XMS_NSCONTEXT Namespace Context 20011203

Method GETHEADERNSCONTEXT on Interface IF_XMS_MESSAGE has no exception.

Method GETHEADERS Signature

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

Method GETHEADERS on Interface IF_XMS_MESSAGE has no exception.

Method GET_LOGGING_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning LOGGING Value transfer Type reference (TYPE) SXMSLOG Integration Engine: Logging 20051207
2 Importing PID Call by reference Type reference (TYPE) SXMSPID Integration Engine: Pipeline-ID 20051207

Method GET_LOGGING_STATUS on Interface IF_XMS_MESSAGE has no exception.

Method GET_READ_FROM_SHM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RET Value transfer Type reference (TYPE) CHAR1 Einstelliges Kennzeichen 20081111

Method GET_READ_FROM_SHM on Interface IF_XMS_MESSAGE has no exception.

Method GET_VERSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_VERSION Value transfer Type reference (TYPE) SXMS_VERSION 20030919

Method GET_VERSION on Interface IF_XMS_MESSAGE has no exception.

Method INSERTATTACHMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INDEX Call by reference Type reference (TYPE) INT4 Natürliche Zahl 20011203
2 Importing NAME Call by reference Type reference (TYPE) STRING Name der Ressource 20011203
3 Importing RESOURCE Call by reference Object reference (TYPE REF TO) IF_XMS_RESOURCE ressource im Inhalt 20011203

Method INSERTATTACHMENT on Interface IF_XMS_MESSAGE has no exception.

Method INSERTBODY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INDEX Call by reference Type reference (TYPE) INT4 index 20011203
2 Importing LCNAME Call by reference Type reference (TYPE) STRING lokaler Name 20011203
3 Importing NSURI Call by reference Type reference (TYPE) STRING Namespace URI 20011203
4 Importing PROP Call by reference Object reference (TYPE REF TO) IF_XMS_PROP in einen String serialisierbare Property 20011203

Method INSERTBODY on Interface IF_XMS_MESSAGE has no exception.

Method INSERTHEADER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INDEX Call by reference Type reference (TYPE) INT4 index 20011203
2 Importing LCNAME Call by reference Type reference (TYPE) STRING lokaler Name 20011203
3 Importing NSURI Call by reference Type reference (TYPE) STRING Namespace URI 20011203
4 Importing PROP Call by reference Object reference (TYPE REF TO) IF_XMS_PROP in einen String serialisierbare Property 20011203

Method INSERTHEADER on Interface IF_XMS_MESSAGE has no exception.

Method MODIFY_ERR_HEADER_FROM_EXCEPT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing EXCEPTION Call by reference Object reference (TYPE REF TO) CX_XMS_SYSTEM_ERROR XI: Systemfehler 20051214

Method MODIFY_ERR_HEADER_FROM_EXCEPT on Interface IF_XMS_MESSAGE has no exception.

Method NUMBEROFATTACHMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning SIZE Value transfer Type reference (TYPE) INT4 Natürliche Zahl 20011203

Method NUMBEROFATTACHMENTS on Interface IF_XMS_MESSAGE has no exception.

Method NUMBEROFBODIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning SIZE Value transfer Type reference (TYPE) INT4 20011203

Method NUMBEROFBODIES on Interface IF_XMS_MESSAGE has no exception.

Method NUMBEROFHEADERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning SIZE Value transfer Type reference (TYPE) INT4 20011203

Method NUMBEROFHEADERS on Interface IF_XMS_MESSAGE has no exception.

Method PAYLOAD_CHANGED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning PAYLOAD_CHANGED Value transfer Type reference (TYPE) CHAR1 Einstelliges Kennzeichen 20050317

Method PAYLOAD_CHANGED on Interface IF_XMS_MESSAGE has no exception.

Method SETBODYNSCONTEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTEXT Call by reference Object reference (TYPE REF TO) IF_XMS_NSCONTEXT Namespace Context 20011203

Method SETBODYNSCONTEXT on Interface IF_XMS_MESSAGE has no exception.

Method SETHEADERNSCONTEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTEXT Call by reference Object reference (TYPE REF TO) IF_XMS_NSCONTEXT Namespace Context 20011203

Method SETHEADERNSCONTEXT on Interface IF_XMS_MESSAGE has no exception.

Method SETUP_TRACE_LEVEL Signature

Method SETUP_TRACE_LEVEL on Interface IF_XMS_MESSAGE has no parameter.
Method SETUP_TRACE_LEVEL on Interface IF_XMS_MESSAGE has no exception.

Method SET_READ_FROM_SHM Signature

Method SET_READ_FROM_SHM on Interface IF_XMS_MESSAGE has no parameter.
Method SET_READ_FROM_SHM on Interface IF_XMS_MESSAGE has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 620