SAP ABAP Class CL_STCTM_XML_UTILITIES (Helper methods for XML processing)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-INS-TC-RT (Application Component) Runtime for ABAP based automated TC
     ⤷ STC_TM (Package) Technical Configuration Task Management

Properties

Class	CL_STCTM_XML_UTILITIES
Short Description	Helper methods for XML processing
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	STC_TM
Program status
Category	0
Package	STC_TM	Technical Configuration Task Management
Created	20121002	SAP
Last change	20141121
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CL_IXML	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_STCTM_PERSISTENCE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
4	CL_STCTM_REPORT_UI	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
5	CL_STCTM_TASKLIST	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
6	IF_STCTM_TASK	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
7	IF_STCTM_TASK_SECSTORE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
8	IF_STCTM_UI_TASK	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
9	IXML	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
10	SEOS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_STCTM_XML_UTILITIES has no interface implemented.

Friends

Class CL_STCTM_XML_UTILITIES has no friend class.

Attributes

Class CL_STCTM_XML_UTILITIES has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_REPORT_UI_INCONSIST	Static method	Private	Method	check if report ui based task has changed incompatibly	20121127
2	COPY_TASK_ATTR_TO_DUMMY_TASK	Static method	Private	Method	copy task related attributes from one task to an other	20121128
3	GET_REPORT_UI_TASK_ATTR	Static method	Private	Method	only used as helper for lcl_xml_handler	20121119
4	GET_SESSION_FROM_XML	Static method	Public	Method	Get Task List Run from Task List Run XML	20121012
5	GET_TASK_FROM_XML	Static method	Public	Method	Get Task from single Task XML	20121012
6	GET_TASK_LOG_INSTANCE	Static method	Private	Method	only used as helper for lcl_xml_handler	20121011
7	GET_TEMPLATE_FROM_XML	Static method	Public	Method	Get Task List Variant from Task List Variant XML	20121012
8	GET_XML_FOR_SESSION	Static method	Public	Method	Get Task List Run XML respresentation for Task List Run	20121012
9	GET_XML_FOR_TASK	Static method	Public	Method	Get Task XML respresentation for a single Task	20121012
10	GET_XML_FOR_TEMPLATE	Static method	Public	Method	Get Task List Variant XML respresentation for Task List Var.	20121012
11	SET_DUMMY_TASK_ATTR	Static method	Private	Method	only used as helper for lcl_xml_handler	20121018
12	SET_REPORT_UI_TASK_ATTR	Static method	Private	Method	only used as helper for lcl_xml_handler	20121119
13	UPDATE_REPORT_UI_TASK	Static method	Private	Method	only used as helper for lcl_xml_handler	20121127
14	UPDATE_TASK_IN_TASKLIST	Static method	Private	Method	only used as helper for lcl_xml_handler	20121119

Events

Class CL_STCTM_XML_UTILITIES has no event.

Types

Class CL_STCTM_XML_UTILITIES has no local type.

Method Signatures

Method CHECK_REPORT_UI_INCONSIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_TASK	Call by reference	☐	Object reference (TYPE REF TO)	CL_STCTM_REPORT_UI		Report User Interface Superclass	20121127
2	Importing	I_TASKNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		Task ID	20121127
3	Importing	I_TASKTYPE	Call by reference	☐	Type reference (TYPE)	STC_TASK_TYPE		Task Type	20121127

#	Exception	Resumable	Description	Created on
1	INCONSISTENT	☐	UI has changed incompatibly	20121127

Method COPY_TASK_ATTR_TO_DUMMY_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DUMMY_TASK	Call by reference	☐	Object reference (TYPE REF TO)	CL_STCTM_DUMMY_TASK		Destination Dummy Task	20121128
2	Importing	IR_SRC_TASK	Call by reference	☐	Object reference (TYPE REF TO)	IF_STCTM_TASK		Source Technical Configuration Task	20121128

Method COPY_TASK_ATTR_TO_DUMMY_TASK on class CL_STCTM_XML_UTILITIES has no exception.

Method GET_REPORT_UI_TASK_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SELFIELD	Call by reference	☐	Type reference (TYPE)	CL_STCTM_REPORT_UI=>TT_SELFIELD		Selection Screen Parameter Definitions	20121119
2	Exporting	ET_VARIANT	Call by reference	☐	Type reference (TYPE)	CL_STCTM_REPORT_UI=>TT_VARIANT		Selection Screen Parameter Values	20121119
3	Exporting	E_REPORTNAME	Call by reference	☐	Type reference (TYPE)	PROGNAME		ABAP Program Name	20121119
4	Importing	IR_TASK	Call by reference	☐	Object reference (TYPE REF TO)	CL_STCTM_REPORT_UI		Report User Interface Superclass	20121119

Method GET_REPORT_UI_TASK_ATTR on class CL_STCTM_XML_UTILITIES has no exception.

Method GET_SESSION_FROM_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_MESSAGES	Call by reference	☐	Object reference (TYPE REF TO)	CL_STCTM_MESSAGES		Task Manager Messages	20121022
2	Exporting	ER_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_STCTM_SESSION		Task List Run	20121012
3	Exporting	E_REPAIRED	Call by reference	☐	Type reference (TYPE)	SAP_BOOL		'X' if Task List Run is repaired	20130412
4	Importing	I_CHECK_SESSION_ID	Call by reference	☑	Type reference (TYPE)	STC_SESSION_ID		Task List Run	20130418
5	Importing	I_REPAIR	Call by reference	☐	Type reference (TYPE)	SAP_BOOL	'X'	Repair Task List Run in case of errors	20121016
6	Importing	I_XML	Call by reference	☐	Type reference (TYPE)	XSTRING		Task List Run XML	20121012

#	Exception	Resumable	Description	Created on
1	INVALID	☐	Could not create Task List Run from XML	20121012

Method GET_TASK_FROM_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_TASK	Call by reference	☐	Object reference (TYPE REF TO)	IF_STCTM_TASK		Technical Configuration Task	20121012
2	Importing	I_TASKNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		Task ID	20121017
3	Importing	I_TASKTYPE	Call by reference	☐	Type reference (TYPE)	STC_TASK_TYPE		Task Type	20121017
4	Importing	I_XML	Call by reference	☐	Type reference (TYPE)	XSTRING		Task List Run XML	20121012

#	Exception	Resumable	Description	Created on
1	INVALID	☐	Could not create Task from XML	20121012

Method GET_TASK_LOG_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_LOG	Value transfer	☐	Object reference (TYPE REF TO)	CL_STCTM_LOG		Task Log	20121011

Method GET_TASK_LOG_INSTANCE on class CL_STCTM_XML_UTILITIES has no exception.

Method GET_TEMPLATE_FROM_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_MESSAGES	Call by reference	☐	Object reference (TYPE REF TO)	CL_STCTM_MESSAGES		Task Manager Messages	20121023
2	Exporting	ER_TEMPLATE	Call by reference	☐	Object reference (TYPE REF TO)	CL_STCTM_TEMPLATE		Task List Variant	20121012
3	Exporting	E_REPAIRED	Call by reference	☐	Type reference (TYPE)	SAP_BOOL		'X' if Task List Variant is repaired	20130412
4	Importing	I_CHECK_SCENARIO_ID	Call by reference	☑	Type reference (TYPE)	STC_SCENARIO_ID		Task List	20130418
5	Importing	I_CHECK_TEMPLATE_ID	Call by reference	☑	Type reference (TYPE)	STC_TEMPLATE_ID		Task List Variant	20130418
6	Importing	I_REPAIR	Call by reference	☐	Type reference (TYPE)	SAP_BOOL	'X'	Repair Task List Variant in case of errors	20121016
7	Importing	I_XML	Call by reference	☐	Type reference (TYPE)	XSTRING		Task List Run XML	20121012

#	Exception	Resumable	Description	Created on
1	INVALID	☐	Could not create Task List Variant from XML	20121012

Method GET_XML_FOR_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_XML	Call by reference	☐	Type reference (TYPE)	XSTRING		Task List Run XML	20121012
2	Importing	IR_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_STCTM_SESSION		Task List Run	20121012

#	Exception	Resumable	Description	Created on
1	INVALID	☐	Task List Run is invalid	20121012

Method GET_XML_FOR_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SEC_DATA	Call by reference	☐	Type reference (TYPE)	STCTM_T_PARAMETER		Fieldnames and Values	20121012
2	Exporting	E_XML	Call by reference	☐	Type reference (TYPE)	XSTRING		Task XML	20121012
3	Importing	IR_TASK	Call by reference	☐	Object reference (TYPE REF TO)	IF_STCTM_TASK		Technical Configuration Task	20121012

#	Exception	Resumable	Description	Created on
1	INVALID	☐	Task is invalid	20121012

Method GET_XML_FOR_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_XML	Call by reference	☐	Type reference (TYPE)	XSTRING		Task List Variant XML	20121012
2	Importing	IR_TEMPLATE	Call by reference	☐	Object reference (TYPE REF TO)	CL_STCTM_TEMPLATE		Task List Variant	20121012

#	Exception	Resumable	Description	Created on
1	INVALID	☐	Task List Variant is invalid	20121012

Method SET_DUMMY_TASK_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DUMMY_TASK	Call by reference	☐	Object reference (TYPE REF TO)	CL_STCTM_DUMMY_TASK		Dummy Task (not selectable, not executable)	20121018
2	Importing	IR_LOG	Call by reference	☑	Object reference (TYPE REF TO)	CL_STCTM_LOG		Task Log	20121018
3	Importing	IT_PREDECESSOR	Call by reference	☑	Type reference (TYPE)	IF_STCTM_TASK=>TT_TASKNAME		List of Predecessor Tasks	20121019
4	Importing	IT_SUCCESSOR	Call by reference	☑	Type reference (TYPE)	IF_STCTM_TASK=>TT_TASKNAME		List of Successor Tasks	20121019
5	Importing	I_APPL_COMP	Call by reference	☑	Type reference (TYPE)	UFPS_POSID		Application component ID	20121018
6	Importing	I_CHECK_PROGRESS	Call by reference	☑	Type reference (TYPE)	STC_TASK_PROGRESS		Task Check Progress	20130701
7	Importing	I_CHECK_STATUS	Call by reference	☑	Type reference (TYPE)	STC_TASK_CHECK_STATUS		Task Check Status	20121018
8	Importing	I_COMPONENT	Call by reference	☑	Type reference (TYPE)	STC_COMPONENT		Component	20121018
9	Importing	I_MULTIPLE_USAGE	Call by reference	☑	Type reference (TYPE)	IF_STCTM_TASK=>T_BOOL		Multiple Usage	20121018
10	Importing	I_OBSOLETE	Call by reference	☑	Type reference (TYPE)	IF_STCTM_TASK=>T_BOOL		Obsolete	20131106
11	Importing	I_ORIGINAL_XML	Call by reference	☑	Type reference (TYPE)	XSTRING		XML of original task	20121018
12	Importing	I_PHASE	Call by reference	☑	Type reference (TYPE)	STC_PHASE		Automation Phase	20121018
13	Importing	I_PROGRESS	Call by reference	☑	Type reference (TYPE)	STC_TASK_PROGRESS		Task Progress	20130701
14	Importing	I_STATUS	Call by reference	☑	Type reference (TYPE)	STC_TASK_STATUS		Task Status	20121018
15	Importing	I_VARIANT_DESCR	Call by reference	☑	Attribute reference (LIKE)	IF_STCTM_UI_TASK=>P_VARIANT_DESCR		Parameter Description	20121112

Method SET_DUMMY_TASK_ATTR on class CL_STCTM_XML_UTILITIES has no exception.

Method SET_REPORT_UI_TASK_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_TASK	Call by reference	☐	Object reference (TYPE REF TO)	CL_STCTM_REPORT_UI		Report User Interface Superclass	20121119
2	Importing	IT_SELFIELD	Call by reference	☑	Type reference (TYPE)	CL_STCTM_REPORT_UI=>TT_SELFIELD		Selection Screen Parameter Definitions	20121119
3	Importing	IT_VARIANT	Call by reference	☑	Type reference (TYPE)	CL_STCTM_REPORT_UI=>TT_VARIANT		Selection Screen Parameter Values	20121119
4	Importing	I_REPORTNAME	Call by reference	☑	Type reference (TYPE)	PROGNAME		ABAP Program Name	20121119

Method SET_REPORT_UI_TASK_ATTR on class CL_STCTM_XML_UTILITIES has no exception.

Method UPDATE_REPORT_UI_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_TASK	Call by reference	☐	Object reference (TYPE REF TO)	CL_STCTM_REPORT_UI		Report User Interface Superclass	20121127

Method UPDATE_REPORT_UI_TASK on class CL_STCTM_XML_UTILITIES has no exception.

Method UPDATE_TASK_IN_TASKLIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_TASK	Call by reference	☐	Object reference (TYPE REF TO)	IF_STCTM_TASK		Technical Configuration Task	20121119
2	Importing	IR_TASKLIST	Call by reference	☐	Object reference (TYPE REF TO)	CL_STCTM_TASKLIST		Configured List of Tasks	20121119
3	Importing	I_INDEX	Call by reference	☐	Type reference (TYPE)	SY-TABIX		Index of Task in Tasklist	20121119

Method UPDATE_TASK_IN_TASKLIST on class CL_STCTM_XML_UTILITIES has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in	740