SAP ABAP Class CL_ESH_ADAPT_BI (BI Adapter)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_CONTENT_FED_ADAPTERS (Package) Adapters for Federated Search

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_FED_ADAPTER_FEATURES	Federation Search - Adapter Features	20081031
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_FED_FEDERATION_SEARCH	Federation Search Interface	20081031

Properties

Class	CL_ESH_ADAPT_BI
Short Description	BI Adapter
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_CONTENT_FED_ADAPTERS	Adapters for Federated Search
Created	20081031	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_ADAPT_BI has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_FED_ADAPTER_FEATURES	☐	☐	Federation Search - Adapter Features	20081031
2	IF_ESH_FED_FEDERATION_SEARCH	☐	☐	Federation Search Interface	20081031

Friends

Class CL_ESH_ADAPT_BI has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ADAPTER_TYPE	Constant	Private	☐	Type reference (TYPE)	STRING	'BI'	Adapter type	20081031

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONVERT_BI_RESP_TO_ESH_RESP	Static method	Private	Method	Convert the SES response to ESH response	20081118
2	EXECUTE_SEARCH	Static method	Private	Method	Execute search	20081105
3	SET_ERROR_IN_RESPONSE_BUILDER	Static method	Private	Method	Set error in response builder	20081223

Events

Class CL_ESH_ADAPT_BI has no event.

Types

Class CL_ESH_ADAPT_BI has no local type.

Method Signatures

Method CONVERT_BI_RESP_TO_ESH_RESP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_RESP_BUILDER	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_FED_GRP_RESP_BUILDER		Search Responses	20081118
2	Importing	IT_RESULTS	Call by reference	☐	Type reference (TYPE)	SXES_T_RESULTS		Search Results List	20081118
3	Importing	IV_NO_OF_ALL_HITS	Call by reference	☐	Type reference (TYPE)	I		Number of All Hits	20081118
4	Importing	IV_NO_OF_HITS	Call by reference	☐	Type reference (TYPE)	I		Number of Hits in the Hit List	20081118
5	Importing	IV_SEARCH_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector	20081118

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADAPT_EXCEPTION	☐	Exception in the Adapter	20081230

Method EXECUTE_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTR_DIST_RANGES	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_DIST_RANGES		Attribute distribution ranges	20081105
2	Exporting	ET_ATTR_DIST_VALUES	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_DIST_VALUES		Attribute distribution values	20081105
3	Exporting	ET_RESULTS	Call by reference	☐	Type reference (TYPE)	SXES_T_RESULTS		Result table of one search service provider	20081105
4	Exporting	ET_RETURN_CODES	Call by reference	☐	Type reference (TYPE)	SESH_T_RETURN_CODES		Return codes per object type	20090309
5	Exporting	EV_NO_OF_ALL_HITS	Call by reference	☐	Type reference (TYPE)	I			20081105
6	Exporting	EV_NO_OF_HITS	Call by reference	☐	Type reference (TYPE)	I			20081105
7	Importing	IS_ATTR_DIST_GLOBAL	Call by reference	☑	Type reference (TYPE)	SESH_S_ATTR_DIST_GLOBAL		Attribute distibution: Global settings	20081208
8	Importing	IT_ATTR_DIST_DEFINITION	Call by reference	☑	Type reference (TYPE)	TREXT_ATTR_DIST_DEFINITION		Attribute distribution: Definition	20081105
9	Importing	IT_ESH_QUERY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20081105
10	Importing	IT_OBJ_TYPE_IDS	Call by reference	☐	Type reference (TYPE)	SXES_T_OBJECT_TYPE_IDS		Table of object type ids of one search service provider	20081105
11	Importing	IT_RESPONSE_ATTRIBUTE_TYPES	Call by reference	☑	Type reference (TYPE)	ESH_T_IF_MDATA_ATTRIBUTE_TYOBJ			20081105
12	Importing	IT_SORT	Call by reference	☑	Type reference (TYPE)	ESH_T_FED_SORT		Sort attributes	20081105
13	Importing	IV_FROM	Call by reference	☐	Type reference (TYPE)	I			20081105
14	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	LAISO		Language according to ISO 639	20081105
15	Importing	IV_RFCDEST	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20081105
16	Importing	IV_TO	Call by reference	☐	Type reference (TYPE)	I			20081105

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADAPT_EXCEPTION	☐	Exception in the Adapter	20081120

Method SET_ERROR_IN_RESPONSE_BUILDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_RESP_BUILDER	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_FED_GRP_RESP_BUILDER		Responses Builder	20081223
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20081223
3	Importing	IV_ERROR_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING		Error message	20081223

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADAPT_EXCEPTION	☐	Exception in the Adapter	20081223

History

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