SAP ABAP Class CL_ESH_FED_SEARCH_FEDERATER (Search Federator)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_FED_FEDERATION_SEARCH	Federation Search Interface	20080820

Properties

Class	CL_ESH_FED_SEARCH_FEDERATER
Short Description	Search Federator
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

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_FED_FEDERATION_SEARCH	☐	☐	Federation Search Interface	20080820

Friends

Class CL_ESH_FED_SEARCH_FEDERATER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_DEFAULT_TIMEOUT	Constant	Public	☐	Type reference (TYPE)	INT4	5	Default timeout	20090212
2	MR_ATTRIBUTE_MAPPER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_FED_COMMON_ATTR_MAPPER		Common attribute mapper	20091229
3	MR_IF_SEARCH_REQUEST	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_REQUEST		Search request	20090903
4	MR_REQUEST	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_FED_REQUEST_DATA		Search request data	20080930
5	MR_TASK_SCHEDULER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_FED_TASK_SCHEDULER		Task scheduler doing the federation	20080930
6	MS_DEFAULT_IN_SETTINGS	Instance attribute	Private	☐	Type reference (TYPE)	ESH_S_FED_DISTRIBUTION_GLOBAL		Attribute distribution: Global settings	20091221
7	MS_RANKING_SETTINGS	Instance attribute	Private	☐	Type reference (TYPE)	ESH_CU_RANKING		Ranking settings	20100219
8	MT_CONNECTORS	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_FED_SCOPE		Connectors	20090924
9	MT_SCOPE_HIERARCHY	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_FED_SCOPE_HIERARCHY		Scope hierarchy	20081013
10	MT_SUCCESSFUL_CONNECTORS	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_FED_SCOPE		Search scope	20100209
11	MV_DEFAULT_TIMEOUT	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_IF_TIMEOUT		Default timeout	20090123
12	MV_END_TIME	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMPL		Search - end time	20091012
13	MV_IS_BULK	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Is a bulk search	20100111
14	MV_MERGE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Merge	20081013
15	MV_START_TIME	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMPL		Search - start time	20091012

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_DISTRIBUTIONS	Instance method	Private	Method	Add navigation information to responses	20100122
2	CONFIGURE_INT_NAV	Instance method	Private	Method	Configure interactive navigation	20091222
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20080820
4	GET_DEFAULT_DATE_SCALES	Instance method	Private	Method	Get default date scales	20100914
5	GET_RESOLVED_CONNECTORS	Instance method	Public	Method	Get resolved connectors	20091005
6	GET_SEARCH_RUNTIME	Instance method	Public	Method	Get runtime of last search	20091012
7	GROUP_TASKS_BY_SCOPE	Instance method	Private	Method	Create tasks for each adapter	20081013
8	IDENTIFY_INT_NAV_ATTRIBUTES	Instance method	Private	Method	Identify interactive navigation attributes	20091221
9	IS_BULK	Instance method	Public	Method	Is bulk search	20100111
10	MERGE	Instance method	Private	Method	Merge a grouped reponses object	20081013
11	RETRIEVE_SUCCESSFUL_CONNECTORS	Instance method	Private	Method	Retrieve connectors with results	20100209
12	SET_SPONSORED_CONNECTOR	Instance method	Private	Method	Set sponsored connector	20100219

Events

Class CL_ESH_FED_SEARCH_FEDERATER has no event.

Types

Class CL_ESH_FED_SEARCH_FEDERATER has no local type.

Method Signatures

Method ADD_DISTRIBUTIONS 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	20100122
2	Importing	IV_ASYNC_SEARCH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Async Search	20100122
3	Importing	IV_DO_INTERACTIVE_NAVIGATION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Do Interactive Navigation	20100122
4	Importing	IV_IN_MAX_VALUES	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20110120

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

Method CONFIGURE_INT_NAV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_REQUEST_FOR_TASKS	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_FED_REQUEST_DATA		Search Request Data	20091222
2	Importing	IT_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Attributes	20091230

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

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_IF_SEARCH_REQUEST	Call by reference	☑	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_REQUEST		Search Request	20090903

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

Method GET_DEFAULT_DATE_SCALES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20100914

Method GET_DEFAULT_DATE_SCALES on class CL_ESH_FED_SEARCH_FEDERATER has no exception.

Method GET_RESOLVED_CONNECTORS Signature

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

Method GET_RESOLVED_CONNECTORS on class CL_ESH_FED_SEARCH_FEDERATER has no exception.

Method GET_SEARCH_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		Search Runtime (msec)	20091012

Method GET_SEARCH_RUNTIME on class CL_ESH_FED_SEARCH_FEDERATER has no exception.

Method GROUP_TASKS_BY_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_REQUEST_FOR_TASKS	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_FED_REQUEST_DATA		Search Request Data	20091222
2	Importing	IV_FOR_MERGE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	For Merging	20081013

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

Method IDENTIFY_INT_NAV_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_INT_NAVIGATION_ATTRS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20091221
2	Exporting	ET_INT_NAV_RANGE_ATTRS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20100913
3	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20091221
4	Importing	IV_REQUEST_TYPE_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request Type ID	20091221

#	Exception	Resumable	Description	Created on
1	CX_ESH_FED_SEARCH_EXCEPTION	☐	Federated Search Exception	20091221

Method IS_BULK Signature

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

Method IS_BULK on class CL_ESH_FED_SEARCH_FEDERATER has no exception.

Method MERGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_GROUPED_RESPONSES	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSES		Search Responses	20081013
2	Importing	IV_RANK_AND_SORT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090910
3	Returning	RR_MERGED_RESPONSES	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSES		Search Responses	20081013

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

Method RETRIEVE_SUCCESSFUL_CONNECTORS 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	20100209

Method RETRIEVE_SUCCESSFUL_CONNECTORS on class CL_ESH_FED_SEARCH_FEDERATER has no exception.

Method SET_SPONSORED_CONNECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_RESPONSES	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSES		Search Responses	20100219
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20100219

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

History

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