SAP ABAP Class CL_ESH_FED_TASK (Task)

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
Short Description	Task
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	20130531	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 has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_FED_TASK_SCHEDULER	☐	20090112	Task Scheduler Doing the Federation

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_ADAPTER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_ESH_FED_FEDERATION_SEARCH		Federation search interface	20081118
2	MS_RUNTIME_INFOS	Instance attribute	Private	☐	Type reference (TYPE)	S_RUNTIME_INFOS		Runtime information	20090112
3	MT_REQ_RESP_CONTAINER	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_T_FED_BULK_CONTAINER		Request data containers for bulk search	20091218
4	MT_SCOPE	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_FED_SCOPE		Scope of this task	20090114
5	MV_ADAPTER	Instance attribute	Private	☐	Type reference (TYPE)	SEOCLSNAME		Adapter class name	20080820
6	MV_ADAPTER_ERROR_MESSAGE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Error message from adapter	20080926
7	MV_LOGON_GROUP	Instance attribute	Private	☐	Type reference (TYPE)	RZLLI_APCL		Server group for parallelization	20090217
8	MV_RESULTS_FETCHED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Results already fetched	20090223
9	MV_TASK_ID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_FED_TASK_ID		Task ID	20081112
10	MV_TEMPLATE_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_TEMPLATE_TYPE		Template type	20081126
11	MX_EXCEPTION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CX_ESH_IF_ENGINE		ESH interface exception	20080820

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALLBACK	Instance method	Public	Method	Asynchronous callback	20080924
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20080820
3	GET_ADAPTER_CLASS_NAME	Instance method	Public	Method	Get search adapter class name	20081113
4	GET_EXCEPTION	Instance method	Public	Method	Get exception	20081125
5	GET_RESULTS	Instance method	Public	Method	Get the available results	20080820
6	GET_RUNTIME	Instance method	Public	Method	Get task runtime	20081125
7	GET_RUN_ID	Instance method	Public	Method	Get search run ID	20090212
8	GET_SEARCH_SCOPE	Instance method	Public	Method	Get search scope	20090112
9	GET_TEMPLATE_TYPE	Instance method	Public	Method	Get template type of adapter	20090112
10	HAS_FAILED	Instance method	Public	Method	Was unsuccessful	20081125
11	HAS_FINISHED	Instance method	Public	Method	Task has finished	20080930
12	HAS_NEW_RESULTS	Instance method	Public	Method	Task has new results	20090112
13	IN_RECOVERY_MODE	Instance method	Public	Method	Search was performed in recovery mode due to parallel issues	20090112
14	IS_ASYNC	Instance method	Public	Method	Is asynchronous	20081209
15	RESET	Instance method	Public	Method	Reset task if supported by the provider	20090109
16	RUN	Instance method	Public	Method	Run	20081112
17	RUN_ASYNC	Instance method	Public	Method	Run asynchronous	20081112
18	RUN_CONCURRENT	Instance method	Public	Method	Run in a new task	20081112

Events

Class CL_ESH_FED_TASK has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_RUNTIME_INFOS	Private	See coding			20090112	BEGIN OF s_runtime_infos, task_failed TYPE abap_bool, task_finished TYPE abap_bool, starttime TYPE timestampl, endtime TYPE timestampl, timeout TYPE abap_bool, in_recovery_mode TYPE abap_bool, is_async TYPE abap_bool, run_id TYPE int4, END OF s_runtime_infos

Method Signatures

Method CALLBACK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_TASK	Call by reference	☐	Type reference (TYPE)	CLIKE			20080924

Method CALLBACK on class CL_ESH_FED_TASK has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_ADAPTER	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_FED_FEDERATION_SEARCH		Federation Search Interface	20100617
2	Importing	IR_TASK_SCHEDULER	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_FED_TASK_SCHEDULER		Task scheduler doing the federation	20080926
3	Importing	IT_BULK_REQUESTS	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_BULK_REQUEST		Bulk Search Requests	20091218
4	Importing	IV_ADAPTER_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Class Name	20080820
5	Importing	IV_LOGON_GROUP	Call by reference	☑	Type reference (TYPE)	RZLLI_APCL		Server Group for Parallelization	20090217
6	Importing	IV_RUN_ID	Call by reference	☐	Type reference (TYPE)	INT4		Search Run	20090212
7	Importing	IV_TASK_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_FED_TASK_ID		Task Id	20081112
8	Importing	IV_TEMPLATE_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_TEMPLATE_TYPE		Template Type	20081126

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

Method GET_ADAPTER_CLASS_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ADAPTER_NAME	Value transfer	☐	Type reference (TYPE)	SEOCLSNAME		Object Type Name	20081113

Method GET_ADAPTER_CLASS_NAME on class CL_ESH_FED_TASK has no exception.

Method GET_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ERROR_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING			20081125
2	Exporting	EX_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_ESH_IF_ENGINE			20081125

Method GET_EXCEPTION on class CL_ESH_FED_TASK has no exception.

Method GET_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BULK_RESPONSES	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_BULK_RESPONSES		Multiple Bulk Search Responses	20091218
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_RUNTIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RUNTIME	Value transfer	☐	Type reference (TYPE)	ESH_E_FED_RUNTIME		Runtime (msec)	20081125

Method GET_RUNTIME on class CL_ESH_FED_TASK has no exception.

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 has no exception.

Method GET_SEARCH_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SCOPE	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SCOPE		Search Scope	20090112

Method GET_SEARCH_SCOPE on class CL_ESH_FED_TASK has no exception.

Method GET_TEMPLATE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TEMPLATE_TYPE	Value transfer	☐	Type reference (TYPE)	ESH_E_OM_TEMPLATE_TYPE		Template Type	20090112

Method GET_TEMPLATE_TYPE on class CL_ESH_FED_TASK has no exception.

Method HAS_FAILED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_FAILED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081125

Method HAS_FAILED on class CL_ESH_FED_TASK has no exception.

Method HAS_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)	ABAP_BOOL		Boolean variable	20080930

Method HAS_FINISHED on class CL_ESH_FED_TASK 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)	ABAP_BOOL		Boolean variable	20090112

Method HAS_NEW_RESULTS on class CL_ESH_FED_TASK has no exception.

Method IN_RECOVERY_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_FLAG	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090112

Method IN_RECOVERY_MODE on class CL_ESH_FED_TASK has no exception.

Method IS_ASYNC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_FLAG	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081209

Method IS_ASYNC on class CL_ESH_FED_TASK has no exception.

Method RESET Signature

Method RESET on class CL_ESH_FED_TASK has no parameter.

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

Method RUN Signature

Method RUN on class CL_ESH_FED_TASK has no parameter.
Method RUN on class CL_ESH_FED_TASK has no exception.

Method RUN_ASYNC Signature

Method RUN_ASYNC on class CL_ESH_FED_TASK has no parameter.
Method RUN_ASYNC on class CL_ESH_FED_TASK has no exception.

Method RUN_CONCURRENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SUCCEEDED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090908

Method RUN_CONCURRENT on class CL_ESH_FED_TASK has no exception.

History

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