SAP ABAP Class CL_STC_TASK_OBJ_UTILITIES (Task Object Utilities (only intern))

Hierarchy

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

Properties

Class	CL_STC_TASK_OBJ_UTILITIES
Short Description	Task Object Utilities (only intern)
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	STC_TASK
Program status
Category	0
Package	STC_TASK	Technical Configuration Task Definition
Created	20111103	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_STCTM_TASKLIST	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	IF_STCTM_TASK	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_STCTM_UI_TASK	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	SEOC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
5	SEOR	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_STC_TASK_OBJ_UTILITIES has no interface implemented.

Friends

Class CL_STC_TASK_OBJ_UTILITIES has no friend class.

Attributes

Class CL_STC_TASK_OBJ_UTILITIES has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_INTERFACES	Static method	Public	Method	Check task object for valid interface combinations	20120208
2	GET_APPL_COMP	Static method	Public	Method	Get application component ID for support	20120717
3	GET_CLASSNAME	Static method	Public	Method	Get name of ABAP class used for task	20121113
4	GET_COMPONENT	Static method	Public	Method	Get task component by task object	20111103
5	GET_DESCRIPTION	Static method	Public	Method	Get task description by task object	20111103
6	GET_DOCU_OBJECT	Static method	Public	Method	Get doku object for task longtext by task object	20111103
7	GET_DOCU_TEXT	Static method	Public	Method	Get doku text of task longtext by task object as SAPscript	20121010
8	GET_EVENT_FOR_EV_TASK	Static method	Public	Method	Get event for event task	20130314
9	GET_MULTIPLE_USAGE	Static method	Public	Method	Get attribute if task can be used multiple times	20120601
10	GET_OBSOLETE_FLAG	Static method	Public	Method	Get attribute if task is obsolete	20131106
11	GET_PHASE	Static method	Public	Method	Get task automation phase	20120601
12	GET_STATISTICS	Static method	Public	Method	Get task statistics	20130514
13	GET_TASKNAME	Static method	Public	Method	Get task name by task object	20111103
14	GET_TYPE	Static method	Public	Method	Get task type by task object	20111103
15	SHOW_DOCU	Static method	Public	Method	Show task longtext	20121010

Events

Class CL_STC_TASK_OBJ_UTILITIES has no event.

Types

Class CL_STC_TASK_OBJ_UTILITIES has no local type.

Method Signatures

Method CHECK_INTERFACES 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	20120208

#	Exception	Resumable	Description	Created on
1	INVALID	☐	Interface combination is invalid	20120208

Method GET_APPL_COMP 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	20120717
2	Returning	RV_APPL_COMP	Value transfer	☐	Type reference (TYPE)	UFPS_POSID		Application component ID	20120717

Method GET_APPL_COMP on class CL_STC_TASK_OBJ_UTILITIES has no exception.

Method GET_CLASSNAME 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	20121113
2	Returning	R_CLASSNAME	Value transfer	☐	Type reference (TYPE)	SEOCLSNAME		Class Name	20121113

Method GET_CLASSNAME on class CL_STC_TASK_OBJ_UTILITIES has no exception.

Method GET_COMPONENT 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		Task	20111103
2	Returning	RV_COMPONENT	Value transfer	☐	Type reference (TYPE)	STC_COMPONENT		TC Component	20111103

Method GET_COMPONENT on class CL_STC_TASK_OBJ_UTILITIES has no exception.

Method GET_DESCRIPTION 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	20111103
2	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Language	20121112
3	Returning	RV_DESCR	Value transfer	☐	Type reference (TYPE)	STC_TASK_DESCR		TC Task Description	20111103

Method GET_DESCRIPTION on class CL_STC_TASK_OBJ_UTILITIES has no exception.

Method GET_DOCU_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DOKU_ID	Call by reference	☐	Type reference (TYPE)	DOKU_ID		Document class	20111103
2	Exporting	EV_DOKU_LANGT	Call by reference	☐	Type reference (TYPE)	SPTXT		Name of Language	20111103
3	Exporting	EV_DOKU_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU		Language of existing docu	20111103
4	Exporting	EV_DOKU_OBJ	Call by reference	☐	Type reference (TYPE)	DOKU_OBJ		Documentation Object	20111103
5	Exporting	EV_DOKU_VAR1	Call by reference	☐	Type reference (TYPE)	SYMSGV		Variable 1	20120927
6	Exporting	EV_DOKU_VAR2	Call by reference	☐	Type reference (TYPE)	SYMSGV		Variable 2	20120927
7	Exporting	EV_DOKU_VAR3	Call by reference	☐	Type reference (TYPE)	SYMSGV		Variable 3	20120927
8	Exporting	EV_DOKU_VAR4	Call by reference	☐	Type reference (TYPE)	SYMSGV		Variable 4	20120927
9	Importing	IR_TASK	Call by reference	☐	Object reference (TYPE REF TO)	IF_STCTM_TASK		Task	20111103
10	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	'*'	Language Key	20111103

#	Exception	Resumable	Description	Created on
1	INVALID	☐	Documentation invalid	20120724
2	NOT_EXISTS	☐	No further documentation exists	20111103

Method GET_DOCU_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_HEAD	Call by reference	☐	Type reference (TYPE)	THEAD		SAPscript: Text Header	20121010
2	Exporting	ET_LINE	Call by reference	☐	Type reference (TYPE)	TLINE_TAB		List of SAPscript Lines	20121010
3	Exporting	EV_DOKU_ID	Call by reference	☐	Type reference (TYPE)	DOKU_ID		Document class	20130903
4	Exporting	EV_DOKU_OBJ	Call by reference	☐	Type reference (TYPE)	DOKU_OBJ		Documentation Object	20130903
5	Importing	IR_TASK	Call by reference	☐	Object reference (TYPE REF TO)	IF_STCTM_TASK		Task	20121010
6	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	'*'	Language Key	20121010

#	Exception	Resumable	Description	Created on
1	INVALID	☐	Documentation invalid	20121010
2	NOT_EXISTS	☐	No further documentation exists	20121010

Method GET_EVENT_FOR_EV_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_STCTM_EVENT		Event	20130314
2	Exporting	E_EVENTNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		Event Taskname	20130314
3	Importing	IR_SCENARIO	Call by reference	☑	Object reference (TYPE REF TO)	IF_STC_SCENARIO		Task List Interface	20130314
4	Importing	IR_TASK	Call by reference	☑	Object reference (TYPE REF TO)	IF_STCTM_TASK		Technical Configuration Task	20130314

#	Exception	Resumable	Description	Created on
1	EVENT_DONT_EXIST	☐	Event does not exist (anymore)	20130314
2	NOT_AN_EVENT_TASK	☐	Given task is not an event task	20130314
3	NOT_UNIQUE	☐	Event task is used in multiple events	20130314

Method GET_MULTIPLE_USAGE 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		Task	20120601
2	Returning	RV_MULTIPLE_USAGE	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		'X' - Task can be used multiple times, SPACE = single usage	20120601

Method GET_MULTIPLE_USAGE on class CL_STC_TASK_OBJ_UTILITIES has no exception.

Method GET_OBSOLETE_FLAG 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		Task	20131106
2	Returning	RV_OBSOLETE	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		'X' - Task is obsolete	20131106

Method GET_OBSOLETE_FLAG on class CL_STC_TASK_OBJ_UTILITIES has no exception.

Method GET_PHASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_PHASE	Call by reference	☐	Type reference (TYPE)	STC_PHASE		Automation Phase	20120601
2	Exporting	EV_PHASE_DESCR	Call by reference	☐	Type reference (TYPE)	STC_PHASE_DESCR		Automation Phase	20120601
3	Importing	IR_TASK	Call by reference	☐	Object reference (TYPE REF TO)	IF_STCTM_TASK		Technical Configuration Task	20120601

Method GET_PHASE on class CL_STC_TASK_OBJ_UTILITIES has no exception.

Method GET_STATISTICS 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	20130514
2	Returning	RR_STATISTICS	Value transfer	☐	Object reference (TYPE REF TO)	CL_STCTM_TASK_STATISTICS		Task Statistics	20130514

Method GET_STATISTICS on class CL_STC_TASK_OBJ_UTILITIES has no exception.

Method GET_TASKNAME 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		Task	20111103
2	Returning	RV_TASKNAME	Value transfer	☐	Type reference (TYPE)	STC_TASK_ID		Task ID	20111103

Method GET_TASKNAME on class CL_STC_TASK_OBJ_UTILITIES has no exception.

Method GET_TYPE 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		Task	20111103
2	Returning	RV_TASKTYPE	Value transfer	☐	Type reference (TYPE)	STC_TASK_TYPE		TC Task Type	20111103

Method GET_TYPE on class CL_STC_TASK_OBJ_UTILITIES has no exception.

Method SHOW_DOCU 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		Task	20121010
2	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	'*'	Language Key	20121010

#	Exception	Resumable	Description	Created on
1	INVALID	☐	Documentation invalid	20121010
2	NOT_EXISTS	☐	No further documentation exists	20121010

History

Last changed by/on	SAP	20140121
SAP Release Created in	732