SAP ABAP Class CL_ESH_TST_PRC_TASK (Abstraction for All Components in the Hierarchy)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_TST_FWK_PROCESS (Package) Process chain and process control

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_ESH_TST_PRC_CATEGORY	Category of Tasks	20100219
2	Inheritance (c INHERITING FROM c_ref)	CL_ESH_TST_PRC_CONCRETETASK	Concrete task	20100219

Properties

Class	CL_ESH_TST_PRC_TASK
Short Description	Abstraction for All Components in the Hierarchy
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_TST_FWK_PROCESS	Process chain and process control
Created	20100218	SAP
Last change	20110908	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)

Interfaces

Class CL_ESH_TST_PRC_TASK has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_TST_PRC_CATEGORY	☐	20100311	Category of Tasks
2	CL_ESH_TST_PRC_PROCESS	☐	20100219	Process

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_TASK_NAME_TXT	Constant	Protected	☐	Type reference (TYPE)	MSGNR	'001'	Text symbol number of task name, for translation	20100218
2	MR_PARENT	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_ESH_TST_PRC_CATEGORY		Represent a category of tasks	20100218
3	MT_MESSAGES	Instance attribute	Public	☑	Type reference (TYPE)	ESH_T_ADM_BAL_S_MSG		Log messages	20100218
4	MV_HELP_NOTE	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_TST_FWK_NOTE_NUMBER		SAP Note number	20100429
5	MV_IS_LEAF	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL		Is a concrete task?	20100218
6	MV_KEY	Instance attribute	Public	☑	Type reference (TYPE)	ESH_E_TST_FWK_KEY		Task key	20100218
7	MV_NAME	Instance attribute	Public	☑	Type reference (TYPE)	ESH_E_TST_FWK_NAME		Task name	20100218
8	MV_SEVERITY	Instance attribute	Public	☑	Type reference (TYPE)	ESH_E_TST_FWK_SEVERITY		Task severity	20100218
9	MV_SKIPPABLE	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Can be deselected in UI?	20100218
10	MV_SKIPPED	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL		Is deselected?	20100505
11	MV_STATUS	Instance attribute	Public	☑	Type reference (TYPE)	ESH_E_TST_FWK_STATUS		Task execution status	20100218
12	MV_STOP_TEST	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20100218
13	SC_NAME_TASK_KEY	Constant	Public	☐	Type reference (TYPE)	ESH_E_TST_FWK_NV_NAME	'TASK_KEY'	Name of name/value pairs for remote API	20100615
14	SC_NAME_TASK_SEVERITY	Constant	Public	☐	Type reference (TYPE)	ESH_E_TST_FWK_NV_NAME	'TASK_SEVERITY'	Name of name/value pairs for remote API	20100615
15	SC_PARAMETER_SKIPPED	Constant	Public	☐	Type reference (TYPE)	STRING	'flg_skipped'	Parameter name for skipped flag	20100505

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_MESSAGE	Instance method	Public	Method	Add message to task	20100218
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20100218
3	DESERIALZE_FROM_LOG	Instance method	Protected	Method	Deserialize attributes of task from hierarchical log	20100218
4	DO_EXECUTE	Instance method	Protected	Method	Execute task (to be redefined)	20100218
5	DO_PREPARE_EXECUTION	Instance method	Protected	Method	Prepare execution (to be redefined by category)	20100218
6	EXECUTE	Instance method	Public	Method	Execute the test task	20100218
7	GET_KEY	Instance method	Public	Method	Get task key	20100218
8	GET_NAME	Instance method	Public	Method	Get name	20100218
9	GET_PARENT	Instance method	Protected	Method	Get parent	20100218
10	GET_ROOT_TASK	Instance method	Protected	Method	Get the root task instance	20100608
11	GET_SAP_NOTE	Instance method	Public	Method	Get SAP Note	20100420
12	GET_SEVERITY	Instance method	Public	Method	Get severity	20100218
13	GET_SKIPPED	Instance method	Public	Method	Get flag that task is to be skipped during execution	20100509
14	GET_STATUS	Instance method	Public	Method	Get status	20100218
15	MESSAGES_TO_TEXT	Instance method	Protected	Method	Write messages to text table	20100401
16	PREPARE_EXECUTION	Instance method	Public	Method	Prepare execution (called by framework)	20100218
17	SET_ABORTED	Instance method	Protected	Method	Set all tasks with status RUNNING to status ABORTED	20100219
18	SET_ATTRIBUTES	Instance method	Protected	Method	Set attributes	20100311
19	SET_PARENT	Instance method	Protected	Method	Set parent	20100218
20	SET_SEVERITY	Instance method	Public	Method	Set severity	20100421
21	SET_SKIPPED	Instance method	Public	Method	Set flag that task is to be skipped during execution	20100505
22	TEAR_DOWN	Instance method	Public	Method	Teardown (to be redefined)	20100330
23	TO_NAME_VALUE	Instance method	Public	Method	Write task to name/value table	20100615
24	TO_TEXT	Instance method	Public	Method	Write task to text table	20100331

Events

Class CL_ESH_TST_PRC_TASK has no event.

Types

Class CL_ESH_TST_PRC_TASK has no local type.

Method Signatures

Method ADD_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAL_S_MSG		Table Type for Structure BAL_S_MSG	20100218

Method ADD_MESSAGE on class CL_ESH_TST_PRC_TASK has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_ESH_TST_PRC_TASK has no parameter.
Method CONSTRUCTOR on class CL_ESH_TST_PRC_TASK has no exception.

Method DESERIALZE_FROM_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_TASK_LOG_ENTRY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TST_HIL_LOG_ENTRY_TASK		Task log entry	20100218

Method DESERIALZE_FROM_LOG on class CL_ESH_TST_PRC_TASK has no exception.

Method DO_EXECUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_RESULT_SEVERITY	Call by reference	☐	Type reference (TYPE)	ESH_E_TST_FWK_SEVERITY		Task severity	20100218
2	Importing	IR_LOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TST_HIL_LOG_HIERARCHY		Hierarchical logging	20100218

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20100218
2	CX_ESH_CO_INVALID_PARAMETER	☐	Invalid Parameter	20100218
3	CX_ESH_CO_LOCKED	☐	ESH Locking Exception	20100218

Method DO_PREPARE_EXECUTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_LOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TST_HIL_LOG_HIERARCHY		Hierarchical logging	20100218

Method DO_PREPARE_EXECUTION on class CL_ESH_TST_PRC_TASK has no exception.

Method EXECUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_LOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TST_HIL_LOG_HIERARCHY		Hierarchical logging	20100218

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20100218
2	CX_ESH_CO_INVALID_PARAMETER	☐	Invalid Parameter	20100218
3	CX_ESH_CO_LOCKED	☐	ESH Locking Exception	20100218

Method GET_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TASK_KEY	Value transfer	☐	Type reference (TYPE)	ESH_E_TST_FWK_KEY		Task key	20100218

Method GET_KEY on class CL_ESH_TST_PRC_TASK has no exception.

Method GET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NAME	Value transfer	☐	Type reference (TYPE)	ESH_E_TST_FWK_NAME		Task name	20100218

Method GET_NAME on class CL_ESH_TST_PRC_TASK has no exception.

Method GET_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_PARENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TST_PRC_CATEGORY		Represent a category of tasks	20100218

Method GET_PARENT on class CL_ESH_TST_PRC_TASK has no exception.

Method GET_ROOT_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_ROOT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TST_PRC_CATEGORY		Category of tasks	20100608

Method GET_ROOT_TASK on class CL_ESH_TST_PRC_TASK has no exception.

Method GET_SAP_NOTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SAP_NOTE	Value transfer	☐	Type reference (TYPE)	ESH_E_TST_FWK_NOTE_NUMBER		SAP Note Number	20100420

Method GET_SAP_NOTE on class CL_ESH_TST_PRC_TASK has no exception.

Method GET_SEVERITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SEVERITY	Value transfer	☐	Type reference (TYPE)	ESH_E_TST_FWK_SEVERITY		Task severity	20100218

Method GET_SEVERITY on class CL_ESH_TST_PRC_TASK has no exception.

Method GET_SKIPPED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SKIPPED	Value transfer	☐	Type reference (TYPE)	FLAG		value of mv_skipped	20100509

Method GET_SKIPPED on class CL_ESH_TST_PRC_TASK has no exception.

Method GET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	ESH_E_TST_FWK_STATUS		Task status	20100218

Method GET_STATUS on class CL_ESH_TST_PRC_TASK has no exception.

Method MESSAGES_TO_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_TEXT_TABLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TST_PRC_TEXT_TABLE		Text table	20100401

Method MESSAGES_TO_TEXT on class CL_ESH_TST_PRC_TASK has no exception.

Method PREPARE_EXECUTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_LOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TST_HIL_LOG_HIERARCHY		Hierarchical logging	20100218

Method PREPARE_EXECUTION on class CL_ESH_TST_PRC_TASK has no exception.

Method SET_ABORTED Signature

Method SET_ABORTED on class CL_ESH_TST_PRC_TASK has no parameter.
Method SET_ABORTED on class CL_ESH_TST_PRC_TASK has no exception.

Method SET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_KEY	Call by reference	☑	Type reference (TYPE)	ESH_E_TST_FWK_KEY		Task key	20100311
2	Importing	IV_NAME	Call by reference	☑	Type reference (TYPE)	ESH_E_TST_FWK_NAME		Task name	20100311

Method SET_ATTRIBUTES on class CL_ESH_TST_PRC_TASK has no exception.

Method SET_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TST_PRC_CATEGORY		Represent a category of tasks	20100218

Method SET_PARENT on class CL_ESH_TST_PRC_TASK has no exception.

Method SET_SEVERITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SEVERITY	Value transfer	☐	Type reference (TYPE)	ESH_E_TST_FWK_SEVERITY		Task Severity	20100421

Method SET_SEVERITY on class CL_ESH_TST_PRC_TASK has no exception.

Method SET_SKIPPED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SKIPPED	Value transfer	☐	Type reference (TYPE)	FLAG		Flag that task is to be skipped	20100505

Method SET_SKIPPED on class CL_ESH_TST_PRC_TASK has no exception.

Method TEAR_DOWN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_LOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TST_HIL_LOG_HIERARCHY		Hierarchical Logging	20100907

Method TEAR_DOWN on class CL_ESH_TST_PRC_TASK has no exception.

Method TO_NAME_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_NAME_VALUE_PAIRS	Call by reference	☐	Type reference (TYPE)	ESH_T_TST_FWK_NAME_VALUE		Name/value pairs for remote API	20100615

Method TO_NAME_VALUE on class CL_ESH_TST_PRC_TASK has no exception.

Method TO_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_TEXT_TABLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TST_PRC_TEXT_TABLE		Text table helper class	20100401

Method TO_TEXT on class CL_ESH_TST_PRC_TASK has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	730