SAP ABAP Interface IF_XMS_PART (IF_XMS_PART)
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_PART | CL_XMS_PART | 20011218 |
Properties
| Interface | IF_XMS_PART | |
| Short Description | IF_XMS_PART |
General Data
| Package | SXMSMSG | XI: Message Handling |
| Created | 20011218 | SAP |
| Last changed | 20110908 | SAP |
| Unicode checks active |
Forward declarations
Interface IF_XMS_PART has no forward declaration.
Interfaces
Interface IF_XMS_PART has no interface.
Friends
Interface IF_XMS_PART has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | KINDBINARY | Constant | Public | Type reference (TYPE) | CHAR1 | 'B' | Binary | 20011218 | |
| 2 | KINDMULTIPART | Constant | Public | Type reference (TYPE) | CHAR1 | 'M' | Multipart | 20011218 | |
| 3 | KINDTEXT | Constant | Public | Type reference (TYPE) | CHAR1 | 'S' | Text | 20011218 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Adds Value of the Existing Values for Header Name | 20011218 | |
| 2 | Instance method | Public | Method | Gives All Header Values in Name Value Table | 20011218 | |
| 3 | Instance method | Public | Method | Returns Content as a Binary String (if possible) | 20011218 | |
| 4 | Instance method | Public | Method | Returns Charset | 20020114 | |
| 5 | Instance method | Public | Method | Returns Content Type (Mime Type) of Contents | 20011218 | |
| 6 | Instance method | Public | Method | Gets Parameters of Content Type as Name Value Table | 20011218 | |
| 7 | Instance method | Public | Method | Describes this Data Part | 20011218 | |
| 8 | Instance method | Public | Method | Returns All Header Values for the Specified Name | 20011218 | |
| 9 | Instance method | Public | Method | Returns Type (Text, Binary, Multipart) | 20011218 | |
| 10 | Instance method | Public | Method | Returns MIME Type | 20011218 | |
| 11 | Instance method | Public | Method | Returns the Contents as a Multipart Object (if possible) | 20011218 | |
| 12 | Instance method | Public | Method | Returns the Contents as a Text String (if possible) | 20011218 | |
| 13 | Instance method | Public | Method | Sets the Part from Binary String | 20011218 | |
| 14 | Instance method | Public | Method | Sets the Part from Components | 20011218 | |
| 15 | Instance method | Public | Method | Deletes All Header Values of this Part | 20011218 | |
| 16 | Instance method | Public | Method | Deletes All Header Values of this Name | 20011218 | |
| 17 | Instance method | Public | Method | Sets Specified Binary String as Contents | 20011218 | |
| 18 | Instance method | Public | Method | Sets a Name for this Data Part | 20011218 | |
| 19 | Instance method | Public | Method | Sets the Value for the Specified Header Name | 20011218 | |
| 20 | Instance method | Public | Method | Sets the Specified Multipart Object as Contents | 20011218 | |
| 21 | Instance method | Public | Method | Sets Contents | 20020114 | |
| 22 | Instance method | Public | Method | Sets the Specified Text String as Contents | 20011218 | |
| 23 | Instance method | Public | Method | Gives Content (inc. All Subcomponents) as a Binary String | 20011218 | |
| 24 | Instance method | Public | Method | Gives the Part (inc. All Subcomponents) as a Binary String | 20011218 |
Events
Interface IF_XMS_PART has no event.
Types
Interface IF_XMS_PART has no local type.
Method Signatures
Method ADDHEADER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | NAME | Value transfer | Type reference (TYPE) | STRING | 20011218 | ||||
| 2 | VALUE | Value transfer | Type reference (TYPE) | STRING | 20011218 |
Method ADDHEADER on Interface IF_XMS_PART has no exception.
Method GETALLHEADERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | SXMS_NV_T | Table with Name Value Pairs | 20011218 |
Method GETALLHEADERS on Interface IF_XMS_PART has no exception.
Method GETBINARYCONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | XSTRING | 20011218 |
Method GETBINARYCONTENT on Interface IF_XMS_PART has no exception.
Method GETCHARSET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHARSET | Value transfer | Type reference (TYPE) | STRING | Charset | 20020114 |
Method GETCHARSET on Interface IF_XMS_PART has no exception.
Method GETCONTENTTYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | STRING | 20011218 |
Method GETCONTENTTYPE on Interface IF_XMS_PART has no exception.
Method GETCONTENTTYPEPARAMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | SXMS_NV_T | Tabelle mit Name-Wert Paaren | 20011218 |
Method GETCONTENTTYPEPARAMS on Interface IF_XMS_PART has no exception.
Method GETDESCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | STRING | 20011218 |
Method GETDESCRIPTION on Interface IF_XMS_PART has no exception.
Method GETHEADER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | NAME | Value transfer | Type reference (TYPE) | STRING | 20011218 | ||||
| 2 | RETURN | Value transfer | Type reference (TYPE) | SXMS_STR_T | Table of Strings | 20011218 |
Method GETHEADER on Interface IF_XMS_PART has no exception.
Method GETKIND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | CHAR1 | Single-Character Flag | 20011218 |
Method GETKIND on Interface IF_XMS_PART has no exception.
Method GETMIMETYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | STRING | 20011218 |
Method GETMIMETYPE on Interface IF_XMS_PART has no exception.
Method GETMULTIPARTCONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Object reference (TYPE REF TO) | IF_XMS_MULTIPART | IF_XMS_MULTIPART | 20011218 |
Method GETMULTIPARTCONTENT on Interface IF_XMS_PART has no exception.
Method GETTEXTCONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | STRING | 20011218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Ausnahmen der XMS Messaging APIs | 20011219 |
Method READFROM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IN | Call by reference | Type reference (TYPE) | XSTRING | 20011218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exceptions of XMS Messaging APIs | 20011218 |
Method READFROMCOMPONENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BODY | Call by reference | Type reference (TYPE) | XSTRING | 20011218 | ||||
| 2 | CONTENTTYPE | Call by reference | Type reference (TYPE) | STRING | 20011218 | ||||
| 3 | DESCRIPTION | Call by reference | Type reference (TYPE) | STRING | 20011218 | ||||
| 4 | HEADERS | Call by reference | Type reference (TYPE) | SXMS_NV_T | Table with Name Value Pairs | 20011218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exceptions of XMS Messaging APIs | 20011218 |
Method REMOVEALLHEADERS Signature
Method REMOVEALLHEADERS on Interface IF_XMS_PART has no parameter.
Method REMOVEALLHEADERS on Interface IF_XMS_PART has no exception.
Method REMOVEHEADER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | NAME | Value transfer | Type reference (TYPE) | STRING | 20011218 |
Method REMOVEHEADER on Interface IF_XMS_PART has no exception.
Method SETBINARYCONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CONTENT | Call by reference | Type reference (TYPE) | XSTRING | 20011218 | ||||
| 2 | MIMETYPE | Value transfer | Type reference (TYPE) | STRING | 20011218 | ||||
| 3 | PARAMS | Value transfer | Type reference (TYPE) | SXMS_NV_T | Tabelle mit Name-Wert Paaren | 20011218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Ausnahmen der XMS Messaging APIs | 20011218 |
Method SETDESCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DESCRIPTION | Call by reference | Type reference (TYPE) | STRING | 20011218 |
Method SETDESCRIPTION on Interface IF_XMS_PART has no exception.
Method SETHEADER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | NAME | Value transfer | Type reference (TYPE) | STRING | 20011218 | ||||
| 2 | VALUE | Call by reference | Type reference (TYPE) | STRING | 20011218 |
Method SETHEADER on Interface IF_XMS_PART has no exception.
Method SETMULTIPARTCONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CONTENT | Call by reference | Object reference (TYPE REF TO) | IF_XMS_MULTIPART | IF_XMS_MULTIPART | 20011218 | |||
| 2 | PARAMS | Call by reference | Type reference (TYPE) | SXMS_NV_T | Tabelle mit Name-Wert Paaren | 20011218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Ausnahmen der XMS Messaging APIs | 20011218 |
Method SETRAWCONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CONTENT | Call by reference | Type reference (TYPE) | XSTRING | Content | 20020114 | |||
| 2 | CONTENTTYPE | Call by reference | Type reference (TYPE) | STRING | Content-Type | 20020114 |
Method SETRAWCONTENT on Interface IF_XMS_PART has no exception.
Method SETTEXTCONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CONTENT | Call by reference | Type reference (TYPE) | STRING | 20011218 | ||||
| 2 | MIMETYPE | Value transfer | Type reference (TYPE) | STRING | 20011218 | ||||
| 3 | PARAMS | Value transfer | Type reference (TYPE) | SXMS_NV_T | Tabelle mit Name-Wert Paaren | 20011218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Ausnahmen der XMS Messaging APIs | 20011218 |
Method WRITECONTENTTO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | OUT | Value transfer | Type reference (TYPE) | XSTRING | 20011218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exceptions of XMS Messaging APIs | 20011218 |
Method WRITETO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | OUT | Value transfer | Type reference (TYPE) | XSTRING | 20011218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exceptions of XMS Messaging APIs | 20011218 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 620 |