SAP ABAP Interface IF_XMS_RESOURCE (Interface for Message Contents Resource)

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_IDX_IDOC_RESOURCE	IDoc Resource for IDoc Tunneling	20020610
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_XMS_RESOURCE	CL_XMS_RESOURCE	20010531

Properties

Interface	IF_XMS_RESOURCE
Short Description	Interface for Message Contents Resource

General Data

Package	SXMSMSG	XI: Message Handling
Created	20010525	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	IF_XMS_RESOURCE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Interface IF_XMS_RESOURCE has no interface.

Friends

Interface IF_XMS_RESOURCE has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	BINARYRESOURCE	Constant	Public	☐	Type reference (TYPE)	CHAR1	'B'	Single-Character Flag	20010530
2	MIMETYPEBIN	Constant	Public	☐	Type reference (TYPE)	STRING	'application/octet-stream'	Mime Type Binary Data (OBSOLETE)	20010531
3	MIMETYPEXML	Constant	Public	☐	Type reference (TYPE)	STRING	'text/xml'	Mime Type XML (OBSOLETE)	20010531
4	MIMETYPE_APPLICATION_OCTET	Constant	Public	☐	Type reference (TYPE)	STRING	'application/octet-stream'		20011218
5	MIMETYPE_APPLICATION_XML	Constant	Public	☐	Type reference (TYPE)	STRING	'application/xml'		20011218
6	MIMETYPE_EXCEL	Constant	Public	☐	Type reference (TYPE)	STRING	'application/msexcel'		20011218
7	MIMETYPE_GIF	Constant	Public	☐	Type reference (TYPE)	STRING	'image/gif'		20011218
8	MIMETYPE_IDOC	Constant	Public	☐	Type reference (TYPE)	STRING	'application/x-sap.idoc.bin'		20021016
9	MIMETYPE_JPEG	Constant	Public	☐	Type reference (TYPE)	STRING	'image/jpeg'		20011218
10	MIMETYPE_MP3	Constant	Public	☐	Type reference (TYPE)	STRING	'audio/mpeg'		20011218
11	MIMETYPE_MPEG	Constant	Public	☐	Type reference (TYPE)	STRING	'video/mpeg'		20011218
12	MIMETYPE_MSWORD	Constant	Public	☐	Type reference (TYPE)	STRING	'application/msword'		20011218
13	MIMETYPE_PDF	Constant	Public	☐	Type reference (TYPE)	STRING	'application/pdf'		20011218
14	MIMETYPE_POSTSCRIPT	Constant	Public	☐	Type reference (TYPE)	STRING	'application/postscript'		20011218
15	MIMETYPE_POWERPOINT	Constant	Public	☐	Type reference (TYPE)	STRING	'application/mspowerpoint'		20011218
16	MIMETYPE_TEXT_HTML	Constant	Public	☐	Type reference (TYPE)	STRING	'text/html'		20011218
17	MIMETYPE_TEXT_PLAIN	Constant	Public	☐	Type reference (TYPE)	STRING	'text/plain'		20011218
18	MIMETYPE_TEXT_XML	Constant	Public	☐	Type reference (TYPE)	STRING	'text/xml'		20011218
19	MIMETYPE_TIFF	Constant	Public	☐	Type reference (TYPE)	STRING	'image/tiff'		20011218
20	MIMETYPE_ZIP	Constant	Public	☐	Type reference (TYPE)	STRING	'application/zip'		20011218
21	TEXTRESOURCE	Constant	Public	☐	Type reference (TYPE)	CHAR1	'T'	Single-Character Flag	20010530
22	_PAYLOAD_CHANGED	Instance attribute	Public	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20050317

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLEAR_PAYLOAD_CHANGED_FLAG	Instance method	Public	Method	Deletes Payload-Change Indictor	20050317
2	GETBINARYDATA	Instance method	Public	Method	Gets Data as Binary String	20010531
3	GETBLOBDATA	Instance method	Public	Method	Gets Data as Blob String	20020529
4	GETKIND	Instance method	Public	Method	Gets the Type of Data (T or B)	20010530
5	GETTEXTDATA	Instance method	Public	Method	Gets Data for Kind = TEXTRESOURCE	20010531
6	GETTYPE	Instance method	Public	Method	Gets Content Type of Resource	20010531
7	GET_ATTRIBUTES	Instance method	Public	Method		20070716
8	PAYLOAD_CHANGED	Instance method	Public	Method	Gets Payload-Change Indicator	20050317
9	SETBINARYDATA	Instance method	Public	Method	Sets Data as Binary String	20010713
10	SETBLOBDATA	Instance method	Public	Method	Sets Data as Blob String	20020529
11	SETTEXTDATA	Instance method	Public	Method	Sets Data for Kind = TEXTRESOURCE	20010713
12	SET_ATTRIBUTES	Instance method	Public	Method		20070716

Events

Interface IF_XMS_RESOURCE has no event.

Types

Interface IF_XMS_RESOURCE has no local type.

Method Signatures

Method CLEAR_PAYLOAD_CHANGED_FLAG Signature

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

Method GETBINARYDATA Signature

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

#	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	20020710

Method GETBLOBDATA Signature

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

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20020710

Method GETKIND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	KIND	Value transfer	☐	Type reference (TYPE)	CHAR1		Art der Ressource	20010530

Method GETKIND on Interface IF_XMS_RESOURCE has no exception.

Method GETTEXTDATA Signature

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

#	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	20020710

Method GETTYPE Signature

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

Method GETTYPE on Interface IF_XMS_RESOURCE has no exception.

Method GET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	INDEX	Call by reference	☐	Type reference (TYPE)	I			20070719
2	Changing	MO_ATTR	Call by reference	☐	Type reference (TYPE)	SXMS_MO_ATTR		Struktur für Message Objekt	20070716
3	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20070716

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20070716

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_RESOURCE has no exception.

Method SETBINARYDATA 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			20010713
2	Importing	TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20010713

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20020710

Method SETBLOBDATA 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			20020529
2	Importing	TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20020529

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20020710

Method SETTEXTDATA 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			20010713
2	Importing	TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20010713

#	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	20020710

Method SET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDEX	Call by reference	☐	Type reference (TYPE)	I			20070719
2	Importing	MO_ATTR	Call by reference	☐	Type reference (TYPE)	SXMS_MO_ATTR		Struktur für Message Objekt	20070716
3	Exporting	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20070716

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20070716

History

Last changed by/on	SAP	20110908
SAP Release Created in	620