SAP ABAP Class CL_ESH_FED_TASK_SCHEDULER (Task Scheduler Doing the Federation)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_FEDERATION (Package) Federation

Properties

Class	CL_ESH_FED_TASK_SCHEDULER
Short Description	Task Scheduler Doing the Federation
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_FEDERATION	Federation
Created	20080820	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_FED_TASK_SCHEDULER has no interface implemented.

Friends

Class CL_ESH_FED_TASK_SCHEDULER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_RESPONSES	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSES		Collected responses	20080820
2	MT_TASKS	Instance attribute	Private	☐	Type reference (TYPE)	LT_T_TASK			20080930
3	MV_IS_ASYNC	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Is asynchronous	20081118
4	MV_LAST_NO_OF_FINISHED_TASKS	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Natural number	20080930
5	MV_LAST_TASK_ID	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Last task number	20080930
6	MV_LOGON_GROUP	Instance attribute	Private	☐	Type reference (TYPE)	RZLLI_APCL		Logon group	20090217
7	MV_RUN_ID	Instance attribute	Private	☐	Type reference (TYPE)	INT4		ID of search run	20090212
8	MV_START_TIMESTAMP	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMP		Search start	20090212
9	MV_TIMEOUT	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_FED_TIMEOUT		Timeout	20081013

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADAPTER_IS_ASYNC_ABLE	Instance method	Private	Method	Adapter can be called asynchronously	20081113
2	ADD_TASK_FROM_GROUP	Instance method	Public	Method	Create search task from connector group	20080820
3	ALL_NON_ASYNC_TASKS_FINISHED	Instance method	Public	Method	Are all tasks finished?	20081209
4	ALL_TASKS_FINISHED	Instance method	Public	Method	Are all tasks finished?	20080930
5	APPEND_RESPONSES	Instance method	Private	Method	Append responses to the system's own responses	20080926
6	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20080926
7	GET_NEXT_TASK_ID	Instance method	Private	Method	Get next task ID	20081013
8	GET_NUMBER_OF_FINISHED_TASKS	Instance method	Private	Method	Get number of finished tasks	20080930
9	GET_NUMBER_OF_RUNNING_TASKS	Instance method	Private	Method	Get number of running tasks	20080930
10	GET_RESULTS	Instance method	Public	Method	Get the available results	20080820
11	GET_RUN_ID	Instance method	Public	Method	Get search run ID	20090212
12	GET_STATISTICS	Instance method	Public	Method	Get search statistics	20081125
13	HAS_NEW_RESULTS	Instance method	Public	Method	Has new results	20080930
14	NEXT_RUN	Instance method	Private	Method	Create the next run ID	20090212
15	RESET_TASKS	Instance method	Public	Method	Reset tasks	20081017
16	RUN_ASYNC	Instance method	Public	Method	Run search tasks sync	20080925
17	RUN_SYNC	Instance method	Public	Method	Run search tasks sync	20080820
18	SET_TIMEOUT	Instance method	Public	Method	Set timeout	20091222

Events

Class CL_ESH_FED_TASK_SCHEDULER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LT_S_TASK	Private	See coding			20080930	BEGIN OF lt_s_task, task_id TYPE esh_e_fed_task_id, task TYPE REF TO cl_esh_fed_task, redo TYPE abap_bool, results_fetched TYPE abap_bool, END OF lt_s_task
2	LT_T_TASK	Private	See coding			20080930	lt_t_task TYPE SORTED TABLE OF lt_s_task WITH UNIQUE KEY task_id

Method Signatures

Method ADAPTER_IS_ASYNC_ABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADAPTER	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Object Type Name	20081113
2	Returning	RV_ASYNC_ABLE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081113

Method ADAPTER_IS_ASYNC_ABLE on class CL_ESH_FED_TASK_SCHEDULER has no exception.

Method ADD_TASK_FROM_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_SCOPE_GROUP	Call by reference	☐	Type reference (TYPE)	ESH_S_FED_CONNECTOR_GROUP		Group of Connectors with same template type and connectivity	20080820
2	Importing	IT_BULK_REQUESTS	Call by reference	☑	Type reference (TYPE)	ESH_T_FED_BULK_REQUEST		Bulk Search Requests	20091222
3	Importing	IV_FOR_MERGE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Search always from 1 for merging	20081013

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	Federated Search Exception	20090212

Method ALL_NON_ASYNC_TASKS_FINISHED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_FINISHED	Value transfer	☐	Type reference (TYPE)	BOOLE		Boolean variable	20081209

Method ALL_NON_ASYNC_TASKS_FINISHED on class CL_ESH_FED_TASK_SCHEDULER has no exception.

Method ALL_TASKS_FINISHED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_FINISHED	Value transfer	☐	Type reference (TYPE)	BOOLE		Boolean variable	20080930

Method ALL_TASKS_FINISHED on class CL_ESH_FED_TASK_SCHEDULER has no exception.

Method APPEND_RESPONSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_RESPONSES	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSES		Search Responses	20080926

Method APPEND_RESPONSES on class CL_ESH_FED_TASK_SCHEDULER has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_ESH_FED_TASK_SCHEDULER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20090217

Method GET_NEXT_TASK_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TASK_ID	Value transfer	☐	Type reference (TYPE)	ESH_E_FED_TASK_ID		Task Id	20081013

Method GET_NEXT_TASK_ID on class CL_ESH_FED_TASK_SCHEDULER has no exception.

Method GET_NUMBER_OF_FINISHED_TASKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NUMBER	Value transfer	☐	Type reference (TYPE)	I			20080930

Method GET_NUMBER_OF_FINISHED_TASKS on class CL_ESH_FED_TASK_SCHEDULER has no exception.

Method GET_NUMBER_OF_RUNNING_TASKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NUMBER	Value transfer	☐	Type reference (TYPE)	I			20080930

Method GET_NUMBER_OF_RUNNING_TASKS on class CL_ESH_FED_TASK_SCHEDULER has no exception.

Method GET_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_RESPONSES	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSES		Search Responses	20081209
2	Exporting	ET_CONNECTOR_STATUS	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_CONNECTOR_STATUS		Connector Status (Aynch. Search)	20081209
3	Importing	IV_NEW_RESPONSES_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090223

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20090112

Method GET_RUN_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RUN_ID	Value transfer	☐	Type reference (TYPE)	INT4		Natural number	20090212

Method GET_RUN_ID on class CL_ESH_FED_TASK_SCHEDULER has no exception.

Method GET_STATISTICS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_STATISTICS	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SEARCH_STATISTICS		Federation Search Statistics	20081125

Method GET_STATISTICS on class CL_ESH_FED_TASK_SCHEDULER has no exception.

Method HAS_NEW_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_HAS_NEW_RESULTS	Value transfer	☐	Type reference (TYPE)	BOOLE		Boolean variable	20080930

Method HAS_NEW_RESULTS on class CL_ESH_FED_TASK_SCHEDULER has no exception.

Method NEXT_RUN Signature

Method NEXT_RUN on class CL_ESH_FED_TASK_SCHEDULER has no parameter.
Method NEXT_RUN on class CL_ESH_FED_TASK_SCHEDULER has no exception.

Method RESET_TASKS Signature

Method RESET_TASKS on class CL_ESH_FED_TASK_SCHEDULER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20090324

Method RUN_ASYNC Signature

Method RUN_ASYNC on class CL_ESH_FED_TASK_SCHEDULER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_FED_TASK_EXECUTION	☐	Search task execution error	20080925

Method RUN_SYNC Signature

Method RUN_SYNC on class CL_ESH_FED_TASK_SCHEDULER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20090112

Method SET_TIMEOUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TIMEOUT	Call by reference	☐	Type reference (TYPE)	ESH_E_FED_TIMEOUT		Search Timeout (secs)	20091222

Method SET_TIMEOUT on class CL_ESH_FED_TASK_SCHEDULER has no exception.

History

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