SAP ABAP Class CL_XML_DOCUMENT (XML Document for WF- WEB Activity)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-BMT-WFM (Application Component) SAP Business Workflow
     ⤷ SWXML (Package) Workflow XML FRAMEWORK

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_XML_DOCUMENT_BASE	XML Document - Management (Basis Class)	20000224

Properties

Class	CL_XML_DOCUMENT
Short Description	XML Document for WF- WEB Activity
Super Class	CL_XML_DOCUMENT_BASE	XML Document - Management (Basis Class)
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status	P	SAP Standard Production Program
Category	0
Package	SWXML	Workflow XML FRAMEWORK
Created	19990903	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	SBDST	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_XML_DOCUMENT has no interface implemented.

Friends

Class CL_XML_DOCUMENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_ATTR_CHANGED_AT	Constant	Public	☐	Type reference (TYPE)	BDS_PROPNA	'LAST_CHANGED_AT'	Attribute 'CHANGED_at'	19990913
2	C_ATTR_CHANGED_BY	Constant	Public	☐	Type reference (TYPE)	BDS_PROPNA	'LAST_CHANGED_BY'	Attribute 'CHANGED_BY'	19990913
3	C_ATTR_CREATED_AT	Constant	Public	☐	Type reference (TYPE)	BDS_PROPNA	'CREATED_AT'	Attribute 'CREATED_AT'	19990913
4	C_ATTR_CREATED_BY	Constant	Public	☐	Type reference (TYPE)	BDS_PROPNA	'CREATED_BY'	Attribute 'CREATED_BY'	19990913
5	C_ATTR_DESCRIPT	Constant	Public	☐	Type reference (TYPE)	BDS_PROPNA	'DESCRIPTION'	Attribute 'DESCRIPTION'	19990913
6	C_ATTR_DESCRIPT2	Constant	Public	☐	Type reference (TYPE)	BDS_PROPNA	'WF_DESCRIPTION2'	Attribute 'wf_DESCRIPTION'	19990913
7	C_ATTR_DIRECTION	Constant	Public	☐	Type reference (TYPE)	BDS_PROPNA	'WF_DIRECTION'	Attribute 'DIRECTION'	19990913
8	C_ATTR_LANGUAGE	Constant	Public	☐	Type reference (TYPE)	BDS_PROPNA	'LANGUAGE'	Attribute 'LANGUAGE'	19990913
9	C_ATTR_OBJ_TYPE	Constant	Public	☐	Type reference (TYPE)	BDS_PROPNA	'WF_OBJ_TYPE'	Attribute 'OBJ_TYPEt'	19991207
10	C_ATTR_RELEASE	Constant	Public	☐	Type reference (TYPE)	BDS_PROPNA	'WF_RELEASE'	Attribute 'RELEASE'	19990913
11	C_ATTR_REQUEST_ID	Constant	Public	☐	Type reference (TYPE)	BDS_PROPNA	'WF_REQUEST-ID'	Attribute 'REQUEST_ID'	19990913
12	C_ATTR_ROLE	Constant	Public	☐	Type reference (TYPE)	BDS_PROPNA	'WF_ROLE'	Attribute 'ROLE'	19990913
13	C_BDS_CLASSLOIO	Static Attribute	Public	☐	Type reference (TYPE)	SDOK_LOCL	'BDS_LOC20'	BDS Logical Class	19991112
14	C_BDS_CLASSNAME	Constant	Public	☐	Type reference (TYPE)	SBDST_CLASSNAME	'CL_XML_DOCUMENT'	BDS Class Name	19990903
15	C_BDS_CLASSTYPE	Constant	Public	☐	Type reference (TYPE)	SBDST_CLASSTYPE	'CL'	BDS Class Type	19990903
16	C_BOR_CLASSTYPE	Constant	Public	☐	Type reference (TYPE)	SBDST_CLASSTYPE	'BO'	BDS Class Type	19991207
17	C_MIME_TYPE	Constant	Public	☐	Type reference (TYPE)	BDS_MIMETP	'application/xml'	Document Class	19990903
18	C_REQUEST	Constant	Public	☐	Type reference (TYPE)	SWXML_DIR	'REQUEST'	Inquiry	19990910
19	C_RESPONSE	Constant	Public	☐	Type reference (TYPE)	SWXML_DIR	'RESPONSE'	Reply	19990910
20	C_ROLE_IREQ	Constant	Public	☐	Type reference (TYPE)	SWXML_ROLE	'received request'	Role: Inbound Request	19990914
21	C_ROLE_IRES	Constant	Public	☐	Type reference (TYPE)	SWXML_ROLE	'received response'	Role: Inbound Response	19991217
22	C_ROLE_OREQ	Constant	Public	☐	Type reference (TYPE)	SWXML_ROLE	'sent request'	Role: Outbound Request	19991217
23	C_ROLE_ORES	Constant	Public	☐	Type reference (TYPE)	SWXML_ROLE	'sent response'	Role: Outbound Response	19990914
24	MS_ATTRIBUTE	Instance attribute	Public	☑	Type reference (TYPE)	SWXML_ATTR		Document Attributes	19990906
25	MS_DOC_KEY	Instance attribute	Public	☑	Type reference (TYPE)	SWXML_DKEY		BDS Document Key	19990910
26	M_COMPONENT	Instance attribute	Protected	☐	Type reference (TYPE)	BAPICOMPON		File Size, MIME Type ...	19990906
27	M_OLD_OBJ_KEY	Instance attribute	Public	☑	Type reference (TYPE)	BDS_TYPEID		BDS Object Key (Old)	20000111

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALL_F4	Instance method	Public	Method	Screen	19991116
2	CALL_NAVIGATOR	Static method	Public	Method	Display Business Document Navigator	19990908
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20010216
4	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	19990903
5	DELETE	Instance method	Public	Method	Deletes XML document(s)	19990906
6	DELETE_DOCUMENTS	Static method	Public	Method	Deletes document for transferred keys (FIND)	19990916
7	DISPLAY	Instance method	Public	Method	Display Document in BDN	19990910
8	FIND	Static method	Public	Method	Searches for XML documents and displays them	19990913
9	GET_AS_TABLE	Instance method	Public	Method	Gets DOM as internal table	20000225
10	GET_DOC_ID	Instance method	Public	Method	Gets logical document ID	19991115
11	GET_NODE_SUBTREE	Instance method	Public	Method	Gets subtree as XML document	20000228
12	GET_OBJECT	Instance method	Public	Method	Gets BOR object from attribute structure	19991206
13	GET_PARAMETER	Instance method	Public	Method	Gets parameters of BOR object	19991207
14	LOAD	Instance method	Public	Method	Loads content	19990903
15	LOAD_FROM_ID	Instance method	Public	Method	Loads content	19991115
16	MOVE_TABLE	Static method	Public	Method	Copies binary tables of different length/width	20000228
17	P_PROP2TABLE	Instance method	Protected	Method	Copies attributes to properties table	19991207
18	P_TABLE2PROP	Instance method	Protected	Method	Copies properties table to attributes	19991207
19	P_UPDATE_OBJ_KEY	Instance method	Protected	Method	Updates (and saves) object key	19991207
20	P_UPDATE_PARAMETER	Instance method	Protected	Method	Updates (and saves) parameters	19991207
21	SAVE	Instance method	Public	Method	Saves content of XML file	19990903
22	SAVE_VARIANT	Instance method	Public	Method	Saves XML document as variant	19991217
23	SET_AS_TABLE	Instance method	Public	Method	Converts internal table to DOM	20000225
24	SET_OBJECT	Instance method	Public	Method	Sets BOR object in attribute structure	19991206
25	SET_PARAMETER	Instance method	Public	Method	Sets parameters of BDS object	19991207
26	SET_RELATION_TO	Instance method	Public	Method	Creates relationship to another document	19990913

Events

Class CL_XML_DOCUMENT has no event.

Types

Class CL_XML_DOCUMENT has no local type.

Method Signatures

Method CALL_F4 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SEL_NODE_PATH	Value transfer	☐	Type reference (TYPE)	STRING		gewählter Knoten (Path)	19991126

Method CALL_F4 on class CL_XML_DOCUMENT has no exception.

Method CALL_NAVIGATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OBJECT_KEY	Value transfer	☑	Type reference (TYPE)	BDS_OBJID		Objekt Schlüssel	19991007
2	Importing	SHOW_DOC_INDX	Value transfer	☐	Type reference (TYPE)	SYTABIX	1	Öffne Dokument (index) / 0 = keines	20000113
3	Changing	T_SIGNATURE	Call by reference	☑	Type reference (TYPE)	SBDST_SIGNATURE		Sinature tabelle	19990913

Method CALL_NAVIGATOR on class CL_XML_DOCUMENT has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_XML_DOCUMENT has no parameter.
Method CLASS_CONSTRUCTOR on class CL_XML_DOCUMENT has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Call by reference	☐	Type reference (TYPE)	SDOK_DESCR	''	Beschreibung / Name	19990910
2	Importing	DIRECTION	Call by reference	☐	Type reference (TYPE)	SWXML_DIR	space	Request / Response	19990910
3	Importing	OBJECT_KEY	Call by reference	☑	Type reference (TYPE)	BDS_TYPEID		Objektschlüssel	19991207
4	Importing	OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	BDS_CLSNAM	''	Klassenname	19991207
5	Importing	OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BDS_CLSTYP	CL_XML_DOCUMENT=>C_BOR_CLASSTYPE	Objektart (BO,CL, OT )	19991207
6	Importing	ROLE	Call by reference	☐	Type reference (TYPE)	SWXML_ROLE	space	Rolle	19990910

Method CONSTRUCTOR on class CL_XML_DOCUMENT has no exception.

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC		Errorcode	19990917

Method DELETE on class CL_XML_DOCUMENT has no exception.

Method DELETE_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC		retcode	19990916
2	Importing	SHOW_ERROR	Call by reference	☐	Type reference (TYPE)	XFLAG	SPACE	Fehlermeldung ausgeben	20020111
3	Importing	T_DOC_KEY	Call by reference	☐	Type reference (TYPE)	SWXML_DKEYTAB		dokument Keys	19990916

Method DELETE_DOCUMENTS on class CL_XML_DOCUMENT has no exception.

Method DISPLAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	WITH_BDN	Call by reference	☐	Type reference (TYPE)	XFLAG	SPACE	im Business Document Navigator	19991217

Method DISPLAY on class CL_XML_DOCUMENT has no exception.

Method FIND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	COUNT	Call by reference	☐	Type reference (TYPE)	SYTABIX		Anzahl Datensätze	19990915
2	Importing	DATE_FROM	Call by reference	☐	Type reference (TYPE)	DATUM	sy-datum	von Anlegedatum	19990914
3	Importing	DATE_TO	Call by reference	☐	Type reference (TYPE)	DATUM	sy-datum	bis Anlegedatum	19990914
4	Importing	DIRECTION	Call by reference	☐	Type reference (TYPE)	SWXML_DIR	space	Request / response	19990913
5	Importing	ONLY_NOT_USED	Call by reference	☐	Type reference (TYPE)	XFLAG	SPACE	nur nicht mehr vom Workflow verwendete	20020108
6	Importing	RELEASE	Call by reference	☐	Type reference (TYPE)	SYSAPRL	sy-saprl	release	19990913
7	Importing	REQUEST_ID	Call by reference	☐	Type reference (TYPE)	SWXML_REQ	space	request id	19990913
8	Importing	ROLE	Call by reference	☐	Type reference (TYPE)	SWXML_ROLE	space	Rolle	19990914
9	Importing	SHOW	Call by reference	☐	Type reference (TYPE)	XFLAG	'X'	Anzeigen im Navigator	19990913
10	Importing	TIME_FROM	Call by reference	☐	Type reference (TYPE)	T	'000000'	von Uhrzeit der Anlage	19990914
11	Importing	TIME_TO	Call by reference	☐	Type reference (TYPE)	T	'235959'	bis Uhrzeit der Anlage	19990914
12	Exporting	T_DOC_KEY	Call by reference	☐	Type reference (TYPE)	SWXML_DKEYTAB		gefundene Dokumentschlüssel	19990913

Method FIND on class CL_XML_DOCUMENT has no exception.

Method GET_AS_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RETCODE	Call by reference	☐	Type reference (TYPE)	SYSUBRC		retcode	20000225
2	Exporting	SIZE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Dateigröße (Anzahl Zeichen)	20000225
3	Exporting	TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Tabelle	20000225

Method GET_AS_TABLE on class CL_XML_DOCUMENT has no exception.

Method GET_DOC_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DOC_ID	Value transfer	☐	Type reference (TYPE)	SDOK_LOID		log. Dokument ID	19991115

Method GET_DOC_ID on class CL_XML_DOCUMENT has no exception.

Method GET_NODE_SUBTREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EMBEDDED_ONLY	Value transfer	☐	Type reference (TYPE)	XFLAG	SPACE	vvv	20000228
2	Importing	NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		Knoten ( Wurzel der Teilstruktur)	20000228
3	Returning	SUBTREE	Value transfer	☐	Object reference (TYPE REF TO)	CL_XML_DOCUMENT		sub-Document	20000228

Method GET_NODE_SUBTREE on class CL_XML_DOCUMENT has no exception.

Method GET_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	OBJ_ID	Call by reference	☐	Type reference (TYPE)	SWO_TYPEID		Objektschlüssel	19991206
2	Exporting	OBJ_TYP	Call by reference	☐	Type reference (TYPE)	SWO_OBJTYP		Objekttyp	19991206

Method GET_OBJECT on class CL_XML_DOCUMENT has no exception.

Method GET_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PARAMETER	Value transfer	☐	Type reference (TYPE)	SWXML_ATTR		Parameterstruktur	19991207

Method GET_PARAMETER on class CL_XML_DOCUMENT has no exception.

Method LOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_KEY	Call by reference	☐	Type reference (TYPE)	SWXML_DKEY		Dokument Key	19990910
2	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC		Retcode.	19990910

Method LOAD on class CL_XML_DOCUMENT has no exception.

Method LOAD_FROM_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ID	Call by reference	☐	Type reference (TYPE)	SDOK_LOID		logische Dokument ID	19991115
2	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC		Retcode.	19991115

Method LOAD_FROM_ID on class CL_XML_DOCUMENT has no exception.

Method MOVE_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SIZE	Value transfer	☐	Type reference (TYPE)	SYTABIX		Anzahl Zeichen	20000228
2	Exporting	T_DEST	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Zieltabelle	20000228
3	Importing	T_SOURCE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Quelltabelle	20000228

Method MOVE_TABLE on class CL_XML_DOCUMENT has no exception.

Method P_PROP2TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	T_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SBDST_PROPERTIES		Property-Tabelle	19991207

Method P_PROP2TABLE on class CL_XML_DOCUMENT has no exception.

Method P_TABLE2PROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	T_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SBDST_PROPERTIES		Property-Tabelle	19991207

Method P_TABLE2PROP on class CL_XML_DOCUMENT has no exception.

Method P_UPDATE_OBJ_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NEW_KEY	Value transfer	☐	Type reference (TYPE)	BDS_TYPEID		Neuer Key	19991207
2	Importing	OLD_KEY	Value transfer	☐	Type reference (TYPE)	BDS_TYPEID		Alte Key	19991207
3	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC		retcode	19991207

Method P_UPDATE_OBJ_KEY on class CL_XML_DOCUMENT has no exception.

Method P_UPDATE_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC		retcode	19991207

Method P_UPDATE_PARAMETER on class CL_XML_DOCUMENT has no exception.

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC		retcode	19990910

Method SAVE on class CL_XML_DOCUMENT has no exception.

Method SAVE_VARIANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC		fehlercode	19991217

Method SAVE_VARIANT on class CL_XML_DOCUMENT has no exception.

Method SET_AS_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC		retcode	20000225
2	Importing	SIZE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Dateigröße (Anzahl Zeichen)	20000225
3	Importing	TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Tabelle	20000225

Method SET_AS_TABLE on class CL_XML_DOCUMENT has no exception.

Method SET_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OBJ_ID	Call by reference	☐	Type reference (TYPE)	SWO_TYPEID		Objektschlüssel	19991206
2	Importing	OBJ_TYP	Call by reference	☐	Type reference (TYPE)	SWO_OBJTYP		Objekttyp	19991206
3	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC		retcode	19991207

Method SET_OBJECT on class CL_XML_DOCUMENT has no exception.

Method SET_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARAMETER	Value transfer	☐	Type reference (TYPE)	SWXML_ATTR		Parameterstruktur	19991207

Method SET_PARAMETER on class CL_XML_DOCUMENT has no exception.

Method SET_RELATION_TO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_XML_DOCUMENT		Rel. zu XML_DOCUMENT	19990913

Method SET_RELATION_TO on class CL_XML_DOCUMENT has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	46C