SAP ABAP Class CL_STC_TASK_UTILITIES (Task Utilities)

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_UTILITIES
Short Description	Task Utilities
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	20110125	SAP
Last change	20140121	SAP
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	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)

Interfaces

Class CL_STC_TASK_UTILITIES has no interface implemented.

Friends

Class CL_STC_TASK_UTILITIES has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_CHECK_STATUS	Constant	Public	☐	See coding			Check Status Values	20110420
2	C_MAINTAINED	Constant	Public	☐	See coding			Parameter Maintenance Status	20121009
3	C_PHASE	Constant	Public	☐	See coding			Automation Phases	20110307
4	C_STATUS	Constant	Public	☐	See coding			Execution Status Values	20110307
5	C_TASKTYPE	Constant	Public	☐	See coding			Possible Task Types	20110125
6	PT_STATUS	Static Attribute	Private	☐	See coding			Status Value Buffer	20110215

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_SYNTAX	Static method	Public	Method	Check existence and syntax of task object	20120930
2	FILL_EXT_PARAM	Static method	Public	Method	Fill properties of external parameter	20110204
3	GET_APPL_COMP	Static method	Public	Method	Get application component for task	20120705
4	GET_CHECK_STATUS_DESCR	Static method	Public	Method	Get description for check status	20110421
5	GET_CHECK_STATUS_ICON	Static method	Public	Method	Get check status for icon	20110420
6	GET_COMPONENT	Static method	Public	Method	Get task component	20110217
7	GET_DESCRIPTION	Static method	Public	Method	Get task description	20110125
8	GET_DESCR_CHECK_STATUS	Static method	Public	Method	Get check status for description	20110421
9	GET_DESCR_STATUS	Static method	Public	Method	Get status for description	20110215
10	GET_DOCU_OBJECT	Static method	Public	Method	Get doku object for task longtext	20110405
11	GET_ICON_CHECK_STATUS	Static method	Public	Method	Get icon for check status	20110420
12	GET_ICON_STATUS	Static method	Public	Method	Get icon for status	20110303
13	GET_MULTIPLE_USAGE	Static method	Public	Method	Get info if task can be used multiple times in one task list	20120522
14	GET_OBSOLETE_FLAG	Static method	Public	Method	Get info if task is obsolete in general	20131106
15	GET_ORIGINAL_PHASE	Static method	Public	Method	Get original task phase	20110308
16	GET_OWNER	Static method	Public	Method	Get task owner	20110407
17	GET_PHASE_DESCR	Static method	Public	Method	Get description for phase	20110307
18	GET_STATUS_DESCR	Static method	Public	Method	Get description for status	20110215
19	GET_STATUS_ICON	Static method	Public	Method	Get status for icon	20110303
20	GET_TYPE	Static method	Public	Method	Get task type	20110125
21	GET_TYPE_ICON	Static method	Public	Method	Get icon for task type	20120601
22	RESOLVE_PROFILE_PARAM	Static method	Public	Method	Replace parameter by real values	20110217
23	SHOW_DOCU	Static method	Public	Method	Show task longtext	20110407

Events

Class CL_STC_TASK_UTILITIES has no event.

Types

Class CL_STC_TASK_UTILITIES has no local type.

Method Signatures

Method CHECK_SYNTAX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASKNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		Task ID	20120930
2	Importing	IV_TASKTYPE	Value transfer	☑	Type reference (TYPE)	STC_TASK_TYPE		Task Type	20120930

#	Exception	Resumable	Description	Created on
1	DONT_EXIST	☐	Task object does not exist	20120930
2	SYNTAX_ERROR	☐	Task object contains syntax errors	20120930

Method FILL_EXT_PARAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DATAELEM	Call by reference	☐	Type reference (TYPE)	DDOBJNAME		Name of ABAP Dictionary Object	20110204
2	Importing	IV_FIELDNAME	Call by reference	☐	Type reference (TYPE)	FIELDNAME		Field Name	20110204
3	Importing	IV_MANDATORY	Call by reference	☐	Type reference (TYPE)	MANDATORY	ABAP_FALSE	' ' = Field input is optional, 'X' = is required	20110204
4	Importing	IV_PASSWORD	Call by reference	☐	Type reference (TYPE)	SAP_BOOL	ABAP_FALSE	' ' = Field content is visible; 'X' = should be hidden	20110204
5	Importing	IV_READ_ONLY	Call by reference	☐	Type reference (TYPE)	SAP_BOOL	ABAP_FALSE	' ' = Field is changeable; 'X' = read only	20120117
6	Importing	IV_TEXT	Call by reference	☑	Type reference (TYPE)	AS4TEXT		Short Description of Repository Objects	20111216
7	Importing	IV_VALUE	Call by reference	☑	Type reference (TYPE)	DATA		Default value (should be type STRING)	20110204
8	Returning	RS_EXT_PARAM	Value transfer	☐	Type reference (TYPE)	IF_STCTM_UI_TASK=>TS_EXT_PARAM		External parameter properties	20110204

Method FILL_EXT_PARAM on class CL_STC_TASK_UTILITIES has no exception.

Method GET_APPL_COMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASKNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		Task ID	20120705
2	Importing	IV_TASKTYPE	Value transfer	☑	Type reference (TYPE)	STC_TASK_TYPE		Task Type	20120705
3	Returning	RV_APPL_COMP	Value transfer	☐	Type reference (TYPE)	UFPS_POSID		Application Component ID	20120705

Method GET_APPL_COMP on class CL_STC_TASK_UTILITIES has no exception.

Method GET_CHECK_STATUS_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Language Key of Current Text Environment	20110421
2	Importing	IV_PROGRESS	Call by reference	☑	Type reference (TYPE)	STC_TASK_PROGRESS		Task Check Progress	20130627
3	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	STC_TASK_CHECK_STATUS		Task Check Status	20110421
4	Returning	RV_DESCR	Value transfer	☐	Type reference (TYPE)	STC_TASK_CHECK_STATUS_DESCR		Task Check Status	20110421

Method GET_CHECK_STATUS_DESCR on class CL_STC_TASK_UTILITIES has no exception.

Method GET_CHECK_STATUS_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_IS_BG_TASK	Call by reference	☐	Type reference (TYPE)	SAP_BOOL	'X'	Is Task an executable Task?	20110420
2	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	STC_TASK_CHECK_STATUS		Task Check Status	20110420
3	Returning	RV_ICON	Value transfer	☐	Type reference (TYPE)	ICON-ID		Icon in text fields (substitute display, alias)	20110420

Method GET_CHECK_STATUS_ICON on class CL_STC_TASK_UTILITIES has no exception.

Method GET_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASKNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		TC Task ID	20110217
2	Importing	IV_TASKTYPE	Call by reference	☑	Type reference (TYPE)	STC_TASK_TYPE		TC Task Type	20110217
3	Returning	RV_COMPONENT	Value transfer	☐	Type reference (TYPE)	STC_COMPONENT		TC Component	20110217

Method GET_COMPONENT on class CL_STC_TASK_UTILITIES has no exception.

Method GET_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASKNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		Task ID	20110125
2	Importing	IV_TASKTYPE	Call by reference	☑	Type reference (TYPE)	STC_TASK_TYPE		TC Task Type	20110125
3	Returning	RV_DESCR	Value transfer	☐	Type reference (TYPE)	STC_TASK_DESCR		TC Task Description	20110125

Method GET_DESCRIPTION on class CL_STC_TASK_UTILITIES has no exception.

Method GET_DESCR_CHECK_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DESCR	Value transfer	☐	Type reference (TYPE)	STC_TASK_CHECK_STATUS_DESCR		Task Check Status	20110421
2	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Language Key of Current Text Environment	20110421
3	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	STC_TASK_CHECK_STATUS		Task Check Status	20110421

Method GET_DESCR_CHECK_STATUS on class CL_STC_TASK_UTILITIES has no exception.

Method GET_DESCR_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DESCR	Value transfer	☐	Type reference (TYPE)	STC_TASK_STATUS_DESCR		TC Task Status	20110215
2	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Language Key of Current Text Environment	20110215
3	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	STC_TASK_STATUS		TC Task Status	20110215

Method GET_DESCR_STATUS on class CL_STC_TASK_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	20110405
2	Exporting	EV_DOKU_LANGT	Call by reference	☐	Type reference (TYPE)	SPTXT		Name of Language	20110720
3	Exporting	EV_DOKU_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU		Language of existing docu	20110719
4	Exporting	EV_DOKU_OBJ	Call by reference	☐	Type reference (TYPE)	DOKU_OBJ		Documentation Object	20110405
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	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	'*'	Language Key	20110405
10	Importing	IV_TASKNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		TC Task ID	20110405
11	Importing	IV_TASKTYPE	Call by reference	☑	Type reference (TYPE)	STC_TASK_TYPE		TC Task Type	20110405

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

Method GET_ICON_CHECK_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ICON	Call by reference	☐	Type reference (TYPE)	ICON-ID		Icon in text fields (substitute display, alias)	20110420
2	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	STC_TASK_CHECK_STATUS		Task Check Status	20110420

Method GET_ICON_CHECK_STATUS on class CL_STC_TASK_UTILITIES has no exception.

Method GET_ICON_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ICON	Call by reference	☐	Type reference (TYPE)	ICON-ID		Icon in text fields (substitute display, alias)	20110303
2	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	STC_TASK_STATUS		TC Task Status	20110303

Method GET_ICON_STATUS on class CL_STC_TASK_UTILITIES has no exception.

Method GET_MULTIPLE_USAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASKNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		Task ID	20120522
2	Importing	IV_TASKTYPE	Value transfer	☑	Type reference (TYPE)	STC_TASK_TYPE		Task Type	20120522
3	Returning	RV_MULTIPLE_USAGE	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		'X' if task can be used multiple times	20120522

Method GET_MULTIPLE_USAGE on class CL_STC_TASK_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	IV_TASKNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		Task ID	20131106
2	Importing	IV_TASKTYPE	Value transfer	☑	Type reference (TYPE)	STC_TASK_TYPE		Task Type	20131106
3	Returning	RV_OBSOLETE	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		'X' if task is obsolete	20131106

Method GET_OBSOLETE_FLAG on class CL_STC_TASK_UTILITIES has no exception.

Method GET_ORIGINAL_PHASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASKNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		TC Task ID	20110308
2	Importing	IV_TASKTYPE	Value transfer	☑	Type reference (TYPE)	STC_TASK_TYPE		TC Task Type	20110308
3	Returning	RV_PHASE	Value transfer	☐	Type reference (TYPE)	STC_PHASE		TC Automation Phase	20110308

Method GET_ORIGINAL_PHASE on class CL_STC_TASK_UTILITIES has no exception.

Method GET_OWNER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASKNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		TC Task ID	20110407
2	Importing	IV_TASKTYPE	Value transfer	☑	Type reference (TYPE)	STC_TASK_TYPE		TC Task Type	20110407
3	Returning	RV_OWNER	Value transfer	☐	Type reference (TYPE)	UNAME		User Name	20110407

#	Exception	Resumable	Description	Created on
1	NOT_EXISTS	☐	No further documentation exists	20110407

Method GET_PHASE_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Language Key of Current Text Environment	20110307
2	Importing	IV_PHASE	Call by reference	☐	Type reference (TYPE)	STC_PHASE		Technical Configuration Automation Phase	20110307
3	Returning	RV_DESCR	Value transfer	☐	Type reference (TYPE)	STC_PHASE_DESCR		Technical Configuration Automation Phase	20110307

Method GET_PHASE_DESCR on class CL_STC_TASK_UTILITIES has no exception.

Method GET_STATUS_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Language Key of Current Text Environment	20110215
2	Importing	IV_PROGRESS	Call by reference	☑	Type reference (TYPE)	STC_TASK_PROGRESS		Task Progress	20130627
3	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	STC_TASK_STATUS		Task Status	20110215
4	Returning	RV_DESCR	Value transfer	☐	Type reference (TYPE)	STC_TASK_STATUS_DESCR		Task Status Description	20110215

Method GET_STATUS_DESCR on class CL_STC_TASK_UTILITIES has no exception.

Method GET_STATUS_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	STC_TASK_STATUS		TC Task Status	20110303
2	Returning	RV_ICON	Value transfer	☐	Type reference (TYPE)	ICON-ID		Icon in text fields (substitute display, alias)	20110303

Method GET_STATUS_ICON on class CL_STC_TASK_UTILITIES has no exception.

Method GET_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASKNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		TC Task ID	20110125
2	Returning	RV_TASKTYPE	Value transfer	☐	Type reference (TYPE)	STC_TASK_TYPE		TC Task Type	20110125

Method GET_TYPE on class CL_STC_TASK_UTILITIES has no exception.

Method GET_TYPE_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ICON	Call by reference	☐	Type reference (TYPE)	ICON-ID		Type Icon	20120601
2	Exporting	EV_ICON_W_TOOLTIP	Call by reference	☐	Type reference (TYPE)	TEXT60		Type Icon with Tooltip	20120601
3	Importing	IV_TASKNAME	Call by reference	☑	Type reference (TYPE)	STC_TASK_ID		Task ID	20120601
4	Importing	IV_TASKTYPE	Call by reference	☐	Type reference (TYPE)	STC_TASK_TYPE		Task Type	20120601

Method GET_TYPE_ICON on class CL_STC_TASK_UTILITIES has no exception.

Method RESOLVE_PROFILE_PARAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_OUTPUT	Call by reference	☐	Type reference (TYPE)	CLIKE			20110217
2	Importing	IV_INPUT	Call by reference	☐	Type reference (TYPE)	CLIKE			20110217

Method RESOLVE_PROFILE_PARAM on class CL_STC_TASK_UTILITIES has no exception.

Method SHOW_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	'*'	Language Key	20110407
2	Importing	IV_TASKNAME	Call by reference	☐	Type reference (TYPE)	STC_TASK_ID		TC Task ID	20110407
3	Importing	IV_TASKTYPE	Value transfer	☑	Type reference (TYPE)	STC_TASK_TYPE		TC Task Type	20110407

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

History

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