SAP ABAP Interface IF_XMS_PAYLOAD (Payload API for Integration Engine Message Object)
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_PAYLOAD Payload for Higher Layer API 20011219
Properties
Interface IF_XMS_PAYLOAD  
Short Description Payload API for Integration Engine Message Object    
General Data
Package SXMSMSG   XI: Message Handling 
Created 20011219   SAP 
Last changed 20110908   SAP 
Unicode checks active    
Forward declarations
Interface IF_XMS_PAYLOAD has no forward declaration.
Interfaces
Interface IF_XMS_PAYLOAD has no interface.
Friends
Interface IF_XMS_PAYLOAD has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 TYPE_BINARY Constant Public Type reference (TYPE) CHAR1 'B' Payload Type 20011219
2 TYPE_EMPTY Constant Public Type reference (TYPE) CHAR1 'E' Payload Type 20011219
3 TYPE_TEXT Constant Public Type reference (TYPE) CHAR1 'T' Payload Type 20011219
4 TYPE_UNKNOWN Constant Public Type reference (TYPE) CHAR1 'U' Payload Type 20011219
Methods
# Method Level Visibility Method type Description Created on
1 GETBINARYCONTENT Instance method Public Method Gets Binary Content (For All TYPE) 20011219
2 GETBLOBCONTENT Instance method Public Method Gets Blob Content (For All TYPE) 20020529
3 GETCONTENTTYPE Instance method Public Method Gets Content Type (MIME) 20011219
4 GETDATA Instance method Public Method Gets Attachment 20011219
5 GETDESCRIPTION Instance method Public Method Read Payload Description 20030929
6 GETDOCUMENTNAME Instance method Public Method Gets Document Name 20011219
7 GETLOCATION Instance method Public Method Gets Location (xlink:href) 20011219
8 GETPAYLOADTYPE Instance method Public Method Read Payload Type 20030716
9 GETREFERENCE Instance method Public Method Gets Reference 20011219
10 GETTEXTCONTENT Instance method Public Method Fetches Text Content (If TYPE = 'T') 20011219
11 GETTYPE Instance method Public Method Gets Payload Type 20011219
12 ISAPPLICATIONPAYLOAD Instance method Public Method Gets 'X' for application payload; '' for others 20030115
13 SETBINARYCONTENT Instance method Public Method Sets Binary Content 20011219
14 SETBLOBCONTENT Instance method Public Method Sets Blob Content 20020529
15 SETDATA Instance method Public Method Sets Attachment 20011219
16 SETDESCRIPTION Instance method Public Method Set Payload Description 20030929
17 SETDOCUMENTNAME Instance method Public Method Sets Document Name 20011219
18 SETLOCATION Instance method Public Method Sets Location (xlink:href) 20011219
19 SETPAYLOADTYPE Instance method Public Method Set Payload Type 20030716
20 SETREFERENCE Instance method Public Method Sets Reference 20011219
21 SETTEXTCONTENT Instance method Public Method Sets Text Content 20011219
Events
Interface IF_XMS_PAYLOAD has no event.
Types
Interface IF_XMS_PAYLOAD has no local type.
Method Signatures

Method GETBINARYCONTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RETURN Value transfer Type reference (TYPE) XSTRING 20011219
# Exception Resumable Description Created on
1 CX_XMS_EXCEPTION Ausnahmen der XMS Messaging APIs 20020708
2 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20020926

Method GETBLOBCONTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RETURN Value transfer Type reference (TYPE) XSTRING 20020529
# Exception Resumable Description Created on
1 CX_XMS_EXCEPTION Ausnahmen der XMS Messaging APIs 20020708
2 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20020926

Method GETCONTENTTYPE Signature

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

Method GETCONTENTTYPE on Interface IF_XMS_PAYLOAD has no exception.

Method GETDATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RETURN Value transfer Object reference (TYPE REF TO) IF_XMS_RESOURCE Interface für Message Inhalt Ressource 20011219

Method GETDATA on Interface IF_XMS_PAYLOAD has no exception.

Method GETDESCRIPTION Signature

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

Method GETDESCRIPTION on Interface IF_XMS_PAYLOAD has no exception.

Method GETDOCUMENTNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RETURN Value transfer Type reference (TYPE) STRING dokument name 20011219

Method GETDOCUMENTNAME on Interface IF_XMS_PAYLOAD has no exception.

Method GETLOCATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RETURN Value transfer Type reference (TYPE) STRING location (xlink:href) 20011219

Method GETLOCATION on Interface IF_XMS_PAYLOAD has no exception.

Method GETPAYLOADTYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RETURN Value transfer Type reference (TYPE) SXMSPAYLOADTYPE XI:Typ einer Payload 20030716

Method GETPAYLOADTYPE on Interface IF_XMS_PAYLOAD has no exception.

Method GETREFERENCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RETURN Value transfer Type reference (TYPE) SXMS_MF_S einzelner Eintrag im Manifest 20011219

Method GETREFERENCE on Interface IF_XMS_PAYLOAD has no exception.

Method GETTEXTCONTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RETURN Value transfer Type reference (TYPE) STRING 20011219
# Exception Resumable Description Created on
1 CX_XMS_EXCEPTION Ausnahmen der XMS Messaging APIs 20020708
2 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20020926

Method GETTYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RETURN Value transfer Type reference (TYPE) CHAR1 payload-typ 20011219

Method GETTYPE on Interface IF_XMS_PAYLOAD has no exception.

Method ISAPPLICATIONPAYLOAD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RETURN Value transfer Type reference (TYPE) CHAR1 nicht ' ' fuer Anwendungspayload 20030115

Method ISAPPLICATIONPAYLOAD on Interface IF_XMS_PAYLOAD has no exception.

Method SETBINARYCONTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DATA Call by reference Type reference (TYPE) XSTRING data 20011219
2 Importing TYPE Call by reference Type reference (TYPE) STRING content-type 20011219
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20020926

Method SETBLOBCONTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DATA Call by reference Type reference (TYPE) XSTRING data 20020529
2 Importing TYPE Call by reference Type reference (TYPE) STRING content-type 20020529
# Exception Resumable Description Created on
1 CX_XMS_EXCEPTION Ausnahmen der XMS Messaging APIs 20020708
2 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20020926

Method SETDATA Signature

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

Method SETDATA on Interface IF_XMS_PAYLOAD has no exception.

Method SETDESCRIPTION Signature

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

Method SETDESCRIPTION on Interface IF_XMS_PAYLOAD has no exception.

Method SETDOCUMENTNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DOCUMENTNAME Call by reference Type reference (TYPE) STRING dokument name 20011219

Method SETDOCUMENTNAME on Interface IF_XMS_PAYLOAD has no exception.

Method SETLOCATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LOCATION Call by reference Type reference (TYPE) STRING location (xlink:href) 20011219

Method SETLOCATION on Interface IF_XMS_PAYLOAD has no exception.

Method SETPAYLOADTYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing TYPE Call by reference Type reference (TYPE) SXMSPAYLOADTYPE Typ der Payload 20030716

Method SETPAYLOADTYPE on Interface IF_XMS_PAYLOAD has no exception.

Method SETREFERENCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing REFERENCE Call by reference Type reference (TYPE) SXMS_MF_S einzelner Eintrag im Manifest 20011219

Method SETREFERENCE on Interface IF_XMS_PAYLOAD has no exception.

Method SETTEXTCONTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DATA Call by reference Type reference (TYPE) STRING data 20011219
2 Importing TYPE Call by reference Type reference (TYPE) STRING content-type 20011219
# Exception Resumable Description Created on
1 CX_XMS_EXCEPTION Ausnahmen der XMS Messaging APIs 20020708
2 CX_XMS_SYSTEM_ERROR XMS: Ausnahmeklasse für Systemfehler 20020926
History
Last changed by/on SAP  20110908 
SAP Release Created in 620