SAP ABAP Class CL_ESH_TST_PRC_PROCESS (Process)

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

Properties

Class	CL_ESH_TST_PRC_PROCESS
Short Description	Process
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_TST_FWK_PROCESS	Process chain and process control
Created	20100219	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_ESH_TST_PRC_TASK	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	CL_ESH_TST_PRC_TEXT_TABLE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_ESH_OM_APPLOG	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_ESH_TST_PRC_PROCESS has no interface implemented.

Friends

Class CL_ESH_TST_PRC_PROCESS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_ROOT_TASK	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_TST_PRC_CATEGORY		Represent a category of tasks	20100219
2	MR_TASK_FACTORY	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_ESH_TST_PRC_TASK_FACTORY		Factory for task tree	20100219
3	MV_FLG_SYNCHRONOUS	Instance attribute	Public	☑	Type reference (TYPE)	FLAG		Batch process	20110119
4	MV_JOB_NO	Instance attribute	Protected	☐	Type reference (TYPE)	TBTCJOB-JOBCOUNT		Job ID	20100219
5	MV_PROCESS_HANDLE	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_TST_FWK_PROCESS_HANDLE		Process handle	20100219
6	MV_PROC_FINISHED	Instance attribute	Protected	☐	Type reference (TYPE)	FLAG		Flag process finished	20100331
7	MV_TASK_FACTORY_CLASS_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	SEOCLSNAME		Name of task factory class	20100219
8	SC_JOB_NAME	Constant	Public	☐	Type reference (TYPE)	TBTCO-JOBNAME	'ESH_TST_FRAMEWORK'	Background job name	20100219
9	SC_JOB_NO_SYNCHRONOUS	Constant	Public	☐	Type reference (TYPE)	TBTCJOB-JOBCOUNT	'SYNC'	Dummy job number for synchronous processes	20110119
10	SC_PARAMETER_FLG_PROC_FINISH	Constant	Public	☐	Type reference (TYPE)	STRING	'flag process finished'		20100331
11	SC_PARAMETER_JOB	Constant	Public	☐	Type reference (TYPE)	STRING	'job'	Message variable	20100219
12	SC_SUBOBJECT	Static Attribute	Public	☐	Type reference (TYPE)	BALSUBOBJ	IF_ESH_OM_APPLOG=>SC_LOG_SUBOBJECT_TESTING	Application log: Subobject	20100219
13	ST_FACTORIES	Static Attribute	Protected	☐	Type reference (TYPE)	TT_TASK_FACTORY		Table with task factories	20100219

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Protected	Constructor	Constructor	20100219
2	CREATE	Static method	Public	Method	Create new process	20100219
3	DESERIALIZE_FROM_LOG	Instance method	Protected	Method	Deserialize from log	20100331
4	GET	Static method	Public	Method	Get (read) process	20100219
5	GET_FACTORY_CLASSES	Static method	Public	Method		20100219
6	GET_FACTORY_INSTANCE	Instance method	Public	Method	Get current factory instance	20100219
7	GET_LOG	Instance method	Protected	Method	Get log instance (log needs to exist in DB)	20100331
8	GET_PROCESS_HANDLE	Instance method	Public	Method	Get process handle	20100219
9	GET_ROOT_TASK	Instance method	Public	Method	Get root task	20100219
10	GET_TASK_FACTORY	Static method	Protected	Method	Get task factory instance	20100219
11	IS_ABORTED	Static method	Protected	Method	Check background job status	20100219
12	IS_FINISHED	Instance method	Public	Method	Check whether or not process is finished	20100331
13	RUN	Instance method	Public	Method	Run	20100219
14	RUN_INTERNAL	Instance method	Public	Method	Run (internal method - do not use)	20100219
15	SEARCH_PROCESSES	Static method	Public	Method	Search for processes	20100219
16	START_BACKGROUND_JOB	Instance method	Protected	Method	Start background processing	20100219
17	START_FOREGROUND_JOB	Instance method	Protected	Method	Start background processing	20110119
18	TEAR_DOWN	Instance method	Public	Method	Teardown	20100330
19	TEAR_DOWN_INTERNAL	Instance method	Protected	Method	Teardown	20100331
20	TO_TEXT	Instance method	Public	Method	Write process to text table	20100401
21	WRITE_JOB_NUMBER_TO_LOG	Instance method	Protected	Method	Write job number to log	20110119

Events

Class CL_ESH_TST_PRC_PROCESS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_TASK_FACTORY	Protected	See coding		Structure with task factory data	20100219	BEGIN OF ts_task_factory, task_factory_class_name TYPE seoclsname, task_factory TYPE REF TO if_esh_tst_PRC_task_factory, END OF ts_task_factory
2	TT_TASK_FACTORY	Protected	See coding		Table with task factories	20100219	tt_task_factory TYPE SORTED TABLE OF ts_task_factory WITH UNIQUE KEY task_factory_class_name

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASK_FACTORY_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Name of task factory class	20100219

#	Exception	Resumable	Description	Created on
1	CX_ESH_TST_PRC_EXCEPTION	☐	Process control exception	20100421

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASK_FACTORY_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Name of process factory class	20100219
2	Returning	RR_PROCESS	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TST_PRC_PROCESS		Process	20100219

#	Exception	Resumable	Description	Created on
1	CX_ESH_TST_PRC_EXCEPTION	☐	Process control exception	20100421

Method DESERIALIZE_FROM_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_LOG_DATA	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TST_HIL_LOG_HIERARCHY=>TS_LOG_DATA			20100331
2	Importing	IV_PROCESS_HANDLE	Call by reference	☐	Type reference (TYPE)	ESH_E_TST_FWK_PROCESS_HANDLE		Process Handle	20100331

#	Exception	Resumable	Description	Created on
1	CX_ESH_TST_PRC_EXCEPTION	☐	Process control exception	20100421

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PROCESS_HANDLE	Call by reference	☐	Type reference (TYPE)	ESH_E_TST_FWK_PROCESS_HANDLE		Process handle	20100219
2	Returning	RR_PROCESS	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TST_PRC_PROCESS		Process	20100219

#	Exception	Resumable	Description	Created on
1	CX_ESH_TST_PRC_EXCEPTION	☐	Process control exception	20100421

Method GET_FACTORY_CLASSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_FACTORY_CLASSES	Value transfer	☐	Type reference (TYPE)	SEO_CLASSES		Factory Classes	20100219

Method GET_FACTORY_CLASSES on class CL_ESH_TST_PRC_PROCESS has no exception.

Method GET_FACTORY_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_TASK_FACTORY	Value transfer	☐	Object reference (TYPE REF TO)	IF_ESH_TST_PRC_TASK_FACTORY		Factory for task tree	20100219

Method GET_FACTORY_INSTANCE on class CL_ESH_TST_PRC_PROCESS has no exception.

Method GET_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_LOG	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TST_HIL_LOG_HIERARCHY		Hierarchical logging	20100331

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_INVALID_PARAMETER	☐	Invalid Parameter	20100331

Method GET_PROCESS_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_PROCESS_HANDLE	Value transfer	☐	Type reference (TYPE)	ESH_E_TST_FWK_PROCESS_HANDLE		Process handle	20100219

Method GET_PROCESS_HANDLE on class CL_ESH_TST_PRC_PROCESS 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_TASK	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TST_PRC_CATEGORY		Represent a category of tasks	20100219

Method GET_ROOT_TASK on class CL_ESH_TST_PRC_PROCESS has no exception.

Method GET_TASK_FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASK_FACTORY_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Name of task factory class	20100219
2	Returning	RR_TASK_FACTORY	Value transfer	☐	Object reference (TYPE REF TO)	IF_ESH_TST_PRC_TASK_FACTORY		Factory for task tree	20100219

Method GET_TASK_FACTORY on class CL_ESH_TST_PRC_PROCESS has no exception.

Method IS_ABORTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_JOB_NO	Call by reference	☐	Type reference (TYPE)	TBTCJOB-JOBCOUNT		Job ID	20100219
2	Returning	RV_FLG_ABORTED	Value transfer	☐	Type reference (TYPE)	FLAG		Flag job aborted	20100219

#	Exception	Resumable	Description	Created on
1	CX_ESH_TST_PRC_EXCEPTION	☐	Process control exception	20100421

Method IS_FINISHED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_PROC_FINISHED	Value transfer	☐	Type reference (TYPE)	FLAG		Flag process finished	20100331

Method IS_FINISHED on class CL_ESH_TST_PRC_PROCESS has no exception.

Method RUN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FLG_SYNCHRONOUS	Call by reference	☑	Type reference (TYPE)	FLAG		Execute process synchronous/default is assync in background	20100615
2	Returning	RV_PROCESS_HANDLE	Value transfer	☐	Type reference (TYPE)	ESH_E_TST_FWK_PROCESS_HANDLE		Process handle	20100219

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20100219

Method RUN_INTERNAL Signature

Method RUN_INTERNAL on class CL_ESH_TST_PRC_PROCESS has no parameter.

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

Method SEARCH_PROCESSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PROCESS_DATA	Value transfer	☐	Type reference (TYPE)	ESH_T_TST_FWK_PRC_DATA		Process data	20100219
2	Importing	IV_ALDATE_FROM	Call by reference	☑	Type reference (TYPE)	BALHDR-ALDATE		Application log: date	20100219
3	Importing	IV_ALDATE_TO	Call by reference	☑	Type reference (TYPE)	BALHDR-ALDATE		Application log: date	20100219
4	Importing	IV_ALTIME_FROM	Call by reference	☑	Type reference (TYPE)	BALHDR-ALTIME		Application log: time	20100219
5	Importing	IV_ALTIME_TO	Call by reference	☑	Type reference (TYPE)	BALHDR-ALTIME		Application log: time	20100219
6	Importing	IV_ALUSER	Call by reference	☑	Type reference (TYPE)	BALHDR-ALUSER		Application log: user name	20100219
7	Importing	IV_CLASSNAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Object Type Name	20100219

Method SEARCH_PROCESSES on class CL_ESH_TST_PRC_PROCESS has no exception.

Method START_BACKGROUND_JOB 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	20100219
2	Importing	IV_PROCESS_HANDLE	Call by reference	☐	Type reference (TYPE)	ESH_E_TST_FWK_PROCESS_HANDLE		Process handle	20100219

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

Method START_FOREGROUND_JOB 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	20110119
2	Importing	IV_PROCESS_HANDLE	Call by reference	☐	Type reference (TYPE)	ESH_E_TST_FWK_PROCESS_HANDLE		Process handle	20110119

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

Method TEAR_DOWN Signature

Method TEAR_DOWN on class CL_ESH_TST_PRC_PROCESS has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20100331

Method TEAR_DOWN_INTERNAL 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	20100331

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20100331

Method TO_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TEXT	Call by reference	☐	Type reference (TYPE)	CL_ESH_TST_PRC_TEXT_TABLE=>TT_TEXT		Text table	20100401

Method TO_TEXT on class CL_ESH_TST_PRC_PROCESS has no exception.

Method WRITE_JOB_NUMBER_TO_LOG 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	20110119
2	Importing	IV_JOB_NO	Call by reference	☐	Type reference (TYPE)	TBTCJOB-JOBCOUNT		Job number	20110119

Method WRITE_JOB_NUMBER_TO_LOG on class CL_ESH_TST_PRC_PROCESS has no exception.

History

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