SAP ABAP Class CL_W3_FLOW_DOM_TREE (WAB: Flow Logic - XML Tree)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-TOO-WAB (Application Component) Web Application Builder
     ⤷ SW3_API (Package) ITS: API

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_W3_FLOW_DOM_TREE	WAB: Structure of Flow Logic	20000112
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_W3_FLOW_DOM_TREE_DIAG	Support Routines	20000112

Properties

Class	CL_W3_FLOW_DOM_TREE
Short Description	WAB: Flow Logic - XML Tree
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status	P	SAP Standard Production Program
Category	0
Package	SW3_API	ITS: API
Created	20000112	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_W3_FLOW_DOM_TREE	☐	☐	WAB: Structure of Flow Logic	20000112
2	IF_W3_FLOW_DOM_TREE_DIAG	☐	☐	Support Routines	20000112

Friends

Class CL_W3_FLOW_DOM_TREE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DOM_NODE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		Pointer to Node in iXML DOM	20000112
2	FIRST_CHILD	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		First Child Node	20000112
3	LAST_CHILD	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		Last Subnode	20000112
4	NEXT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		Next Same-Level Node	20000112
5	NODE_TYPE_CONVERTER	Instance attribute	Public	☐	Attribute reference (LIKE)				20000214
6	NODE_TYPE_DEFAULT	Instance attribute	Public	☐	Attribute reference (LIKE)				20000126
7	NODE_TYPE_EVENT	Instance attribute	Public	☐	Attribute reference (LIKE)				20000126
8	NODE_TYPE_EXCEPTIONS	Instance attribute	Public	☐	Attribute reference (LIKE)				20000126
9	NODE_TYPE_EXPRESSION	Instance attribute	Public	☐	Attribute reference (LIKE)				20000126
10	NODE_TYPE_FILEMAPPING	Instance attribute	Public	☐	Attribute reference (LIKE)				20000214
11	NODE_TYPE_FLOW	Instance attribute	Public	☐	Attribute reference (LIKE)				20000126
12	NODE_TYPE_INPUTMAPPING	Instance attribute	Public	☐	Attribute reference (LIKE)				20000126
13	NODE_TYPE_MODULE	Instance attribute	Public	☐	Attribute reference (LIKE)				20000126
14	NODE_TYPE_OUTPUTMAPPING	Instance attribute	Public	☐	Attribute reference (LIKE)				20000126
15	NODE_TYPE_PERSISTENT	Instance attribute	Public	☐	Attribute reference (LIKE)				20000126
16	NODE_TYPE_RESULT	Instance attribute	Public	☐	Attribute reference (LIKE)				20000126
17	NODE_TYPE_STATE	Instance attribute	Public	☐	Attribute reference (LIKE)				20000126
18	NODE_TYPE_UNKNOWN	Instance attribute	Public	☐	Attribute reference (LIKE)				20000126
19	PARENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		Superior Node	20000112
20	PREVIOUS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		Previous Same-Level Node	20000112
21	XML_NAME_CACHE	Static Attribute	Public	☐	Type reference (TYPE)	TDLINE	'cache'	Literal Constant	20000328
22	XML_NAME_NAME	Static Attribute	Public	☐	Type reference (TYPE)	TDLINE	'name'	Literal Constant	20000112
23	XML_NAME_NEXT_STATE	Static Attribute	Public	☐	Type reference (TYPE)	TDLINE	'next_state'	Literal Constant	20000112
24	XML_NAME_NEXT_TEMPLATE	Static Attribute	Public	☐	Type reference (TYPE)	TDLINE	'next_template'	Literal Constant	20000112
25	XML_NAME_POOLED	Static Attribute	Public	☐	Type reference (TYPE)	TDLINE	'pooled'	Literal Constant	20000328
26	XML_NAME_SOURCE	Static Attribute	Public	☐	Type reference (TYPE)	TDLINE	'source'	Literal Constant	20000112
27	XML_NAME_STATEFUL	Static Attribute	Public	☐	Type reference (TYPE)	TDLINE	'stateful'	Literal Constant	20000112
28	XML_NAME_TARGET	Static Attribute	Public	☐	Type reference (TYPE)	TDLINE	'target'	Literal Constant	20000112
29	XML_NAME_TYPE	Static Attribute	Public	☐	Type reference (TYPE)	TDLINE	'type'	Literal Constant	20000112
30	XML_NAME_VALUE	Static Attribute	Public	☐	Type reference (TYPE)	TDLINE	'value'	Literal Constant	20000112
31	XML_NODE_TYPE_CONVERTER	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'converter'	Literal Constant	20000214
32	XML_NODE_TYPE_DEFAULT	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'default'	Literal Constant	20000112
33	XML_NODE_TYPE_EVENT	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'event'	Literal Constant	20000112
34	XML_NODE_TYPE_EXCEPTIONS	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'exception'	Literal Constant	20000112
35	XML_NODE_TYPE_EXPRESSION	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'expr'	Literal Constant	20000113
36	XML_NODE_TYPE_FILEMAPPING	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'filemapping'	Literal Constant	20000214
37	XML_NODE_TYPE_FLOW	Static Attribute	Public	☐	Type reference (TYPE)	TDLINE	'flow'	Literal Constant	20000112
38	XML_NODE_TYPE_INPUTMAPPING	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'inputmapping'	Literal Constant	20000112
39	XML_NODE_TYPE_MODULE	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'module'	Literal Constant	20000112
40	XML_NODE_TYPE_OUTPUTMAPPING	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'outputmapping'	Literal Constant	20000112
41	XML_NODE_TYPE_PERSISTENT	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'persistent'	Literal Constant	20000118
42	XML_NODE_TYPE_RESULT	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'result'	Literal Constant	20000112
43	XML_NODE_TYPE_STATE	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'state'	Literal Constant	20000112
44	XML_TYPE_BOOLE	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'BOOLE'	Literal Constant	20000112
45	XML_TYPE_ENUM	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'ENUM'	Literal Constant	20000112
46	XML_TYPE_ICON	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'ICON'	Literal Constant	20000112
47	XML_TYPE_INT	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'INT'	Literal Constant	20000112
48	XML_TYPE_STRING	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'STRING'	Literal Constant	20000112
49	XML_TYPE_TEXT	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'TEXT'	Literal Constant	20000112
50	XML_VALUE_FALSE	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'FALSE'	Literal Constant	20000112
51	XML_VALUE_TRUE	Static Attribute	Private	☐	Type reference (TYPE)	TDLINE	'TRUE'	Literal Constant	20000112

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_NODE	Instance method	Private	Method	Creates a New Node and Inserts it as Child	20000112
2	CREATE_AND_INSERT_NODE	Static method	Private	Method	Creates a New Node and Inserts it into Tree	20000112
3	CREATE_NODE	Static method	Public	Method	Creates a New Node	20000112
4	DELETE_NODE	Static method	Private	Method	Deletes Current Node	20000112
5	GET_DOM_NAME	Instance method	Public	Method		20000808
6	GET_DOM_TYPE	Instance method	Public	Method		20000808
7	GET_LAST_CHILD	Instance method	Private	Method	Returns the Last Child Node (Maybe NULL)	20000112
8	GET_PREVIOUS	Instance method	Private	Method	Returns the pevious Same-Level Node (Maybe NULL)	20000112
9	HANDLE_ERROR	Static method	Private	Method	Handles Internal Errors	20000112
10	INSERT_CHILD	Instance method	Private	Method	Inserts the Given Subnode Before the Given Reference Node	20000112
11	NODE_TYPE_TO_XML_NAME	Static method	Private	Method	Converts Node Type to XML Name String	20000112
12	REMOVE_CHILD	Instance method	Private	Method	Removes the Given Subnode from the Tree	20000112
13	SET_ATTRIBUTE	Instance method	Public	Method		20000127
14	SET_DOM_NODE	Instance method	Private	Method	Assigns Value to Attribute DOM_NODE	20000112
15	SET_FIRST_CHILD	Instance method	Private	Method	Stores the First Subnode (Maybe NULL)	20000112
16	SET_LAST_CHILD	Instance method	Private	Method	Stores the Last Subnode (Maybe NULL)	20000112
17	SET_NEXT	Instance method	Private	Method	Stores the Next Subnode (Maybe NULL)	20000112
18	SET_PREVIOUS	Instance method	Private	Method	Stores the Previous Same-Level Node (Maybe NULL)	20000112
19	SUPPORTS_ATTRIBUTE	Instance method	Private	Method	Returns True if Node Supports the Given Attribute	20000112
20	XML_NAME_TO_NODE_TYPE	Static method	Private	Method	Converts XML Name String to Node Type	20000112

Events

Class CL_W3_FLOW_DOM_TREE has no event.

Types

Class CL_W3_FLOW_DOM_TREE has no local type.

Method Signatures

Method ADD_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NEW_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		pointer to new instance	20000112
2	Importing	NODE_TYPE	Call by reference	☐	Type reference (TYPE)	I		node type of new node	20000112
3	Importing	SUCCESSOR_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		optional sibling before which node is to insert	20000112

#	Exception	Resumable	Description	Created on
1	ERROR_CREATING	☐	could not create DOM node	20000112
2	ERROR_INSERTING	☐	could not insert DOM node into tree	20000112
3	NO_NODE_TYPE	☐	input parameter NODE_TYPE not supplied	20000112

Method CREATE_AND_INSERT_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NEW_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		pointer to new instance	20000112
2	Importing	NODE_TYPE	Call by reference	☐	Type reference (TYPE)	I		node type of new node	20000112
3	Importing	PARENT_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		parent to which node is to add	20000112
4	Importing	SUCCESSOR_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		optional sibling before which node is to insert	20000112

#	Exception	Resumable	Description	Created on
1	ERROR_CREATING	☐	could not create DOM node	20000112
2	ERROR_INSERTING	☐	could not insert DOM node into tree	20000112
3	NO_NODE_TYPE	☐	input parameter NODE_TYPE not supplied	20000112
4	NO_PARENT_NODE	☐	input parameter PARENT_NODE not supplied	20000112

Method CREATE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOM_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		associated DOM node	20000112
2	Returning	NEW_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		pointer to new instance	20000112
3	Importing	PARENT	Call by reference	☑	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		parent node	20000112

#	Exception	Resumable	Description	Created on
1	ERROR_CREATING	☐	could not create Control Tree node	20000112
2	NO_DOM_NODE	☐	input parameter PARENT_NODE not supplied	20000112

Method DELETE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		node instance to delete	20000112

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	node not found in node table	20000112
2	NO_DOM_NODE	☐	node has no associated DOM node	20000112
3	NO_NODE	☐	input parameter NODE not supplied	20000112
4	TABLE_ERROR	☐	could not locate Control Tree node in node table	20000112

Method GET_DOM_NAME Signature

Method GET_DOM_NAME on class CL_W3_FLOW_DOM_TREE has no parameter.
Method GET_DOM_NAME on class CL_W3_FLOW_DOM_TREE has no exception.

Method GET_DOM_TYPE Signature

Method GET_DOM_TYPE on class CL_W3_FLOW_DOM_TREE has no parameter.
Method GET_DOM_TYPE on class CL_W3_FLOW_DOM_TREE has no exception.

Method GET_LAST_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LAST_CHILD	Value transfer	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		last child node, or NULL	20000112

Method GET_LAST_CHILD on class CL_W3_FLOW_DOM_TREE has no exception.

Method GET_PREVIOUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PREVIOUS	Value transfer	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		previous sibling node, or NULL	20000112

Method GET_PREVIOUS on class CL_W3_FLOW_DOM_TREE has no exception.

Method HANDLE_ERROR Signature

Method HANDLE_ERROR on class CL_W3_FLOW_DOM_TREE has no parameter.
Method HANDLE_ERROR on class CL_W3_FLOW_DOM_TREE has no exception.

Method INSERT_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NEW_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		child node to insert	20000112
2	Importing	SUCCESSOR_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		reference node to insert node before	20000112

#	Exception	Resumable	Description	Created on
1	ERROR_INSERTING	☐	could not insert node into tree	20000112
2	NOT_CHILD	☐	child node is not a child of this instance	20000112
3	NO_DOM_NODE	☐	node has no DOM node	20000112
4	NO_NEW_NODE	☐	input parameter NEW_NODE not supplied	20000112

Method NODE_TYPE_TO_XML_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_TYPE	Call by reference	☐	Type reference (TYPE)	I		enumerated node type	20000112
2	Returning	XML_NAME	Value transfer	☐	Type reference (TYPE)	STRING		XML name string	20000112

Method NODE_TYPE_TO_XML_NAME on class CL_W3_FLOW_DOM_TREE has no exception.

Method REMOVE_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		child node to remove	20000112

#	Exception	Resumable	Description	Created on
1	NOT_CHILD	☐	child node is not a child of this instance	20000112
2	NO_DOM_NODE	☐	given node has no DOM node	20000112
3	NO_NODE	☐	input parameter NODE not supplied	20000112

Method SET_ATTRIBUTE Signature

Method SET_ATTRIBUTE on class CL_W3_FLOW_DOM_TREE has no parameter.
Method SET_ATTRIBUTE on class CL_W3_FLOW_DOM_TREE has no exception.

Method SET_DOM_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOM_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		pointer to DOM node	20000112

Method SET_DOM_NODE on class CL_W3_FLOW_DOM_TREE has no exception.

Method SET_FIRST_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIRST_CHILD	Value transfer	☑	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		first child node, or NULL	20000112

Method SET_FIRST_CHILD on class CL_W3_FLOW_DOM_TREE has no exception.

Method SET_LAST_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LAST_CHILD	Value transfer	☑	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		last child node, or NULL	20000112

Method SET_LAST_CHILD on class CL_W3_FLOW_DOM_TREE has no exception.

Method SET_NEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		next sibling node, or NULL	20000112

Method SET_NEXT on class CL_W3_FLOW_DOM_TREE has no exception.

Method SET_PREVIOUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PREVIOUS	Value transfer	☑	Object reference (TYPE REF TO)	IF_W3_FLOW_DOM_TREE		previous sibling node, or NULL	20000112

Method SET_PREVIOUS on class CL_W3_FLOW_DOM_TREE has no exception.

Method SUPPORTS_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ATTRIBUTE_NAME	Call by reference	☐	Type reference (TYPE)	TDLINE		attribute name	20000112
2	Returning	RVAL	Value transfer	☐	Type reference (TYPE)	BOOLEAN		'X' = true, ' ' = false	20000112

#	Exception	Resumable	Description	Created on
1	NO_NAME	☐	input parameter ATTRIBUTE_NAME not supplied	20000112

Method XML_NAME_TO_NODE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NODE_TYPE	Value transfer	☐	Type reference (TYPE)	I		enumerated node type	20000112
2	Importing	XML_NAME	Value transfer	☐	Type reference (TYPE)	STRING		XML name string	20000112

Method XML_NAME_TO_NODE_TYPE on class CL_W3_FLOW_DOM_TREE has no exception.

History

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