SAP ABAP Class CL_ESH_IF_SEARCH_RESP_CONNECT (Search Response of Connector)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_ESH_IF_SEARCH_RESPONSE	Search Response	20080118

Properties

Class	CL_ESH_IF_SEARCH_RESP_CONNECT
Short Description	Search Response of Connector
Super Class	CL_ESH_IF_SEARCH_RESPONSE	Search Response
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_INTERFACE	Interface
Created	20080118	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_IF_SEARCH_RESP_CONNECT has no forward declaration.

Interfaces

Class CL_ESH_IF_SEARCH_RESP_CONNECT has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_FED_GRP_RESP_BUILDER	☐	20080813	Grouped Response Builder
2	CL_ESH_FED_MRG_RESP_BUILDER	☐	20080821	Grouped Response Builder
3	CL_ESH_FED_OBJECT_PACKER	☐	20081212	Search Entity Accessor
4	CL_ESH_IF_SEARCH_REQUEST	☐	20080626	Search Request
5	CL_ESH_SE_SEARCH_REQUEST	☐	20081013	Search Request
6	CL_ESH_TREX_SEARCH	☐	20100105	Execute an ESH Search on TREX

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MV_NUM_RESULTS_HIGH	Instance attribute	Protected	☐	Type reference (TYPE)	INT4		Number of high results	20091012
2	MV_NUM_RESULTS_MEDIUM	Instance attribute	Protected	☐	Type reference (TYPE)	INT4		Number of medium results	20091012

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_INSTANCE	Static method	Protected	Method	Create instance	20080128
2	GET_RESULTS_DATA_RAW	Instance method	Public	Method	Get the raw data	20080130
3	GET_SCOPE	Instance method	Public	Method	Get the scope used for the search	20080331
4	SET_SOURCE_REQUEST	Instance method	Protected	Method	Set internal source request	20100823

Events

Class CL_ESH_IF_SEARCH_RESP_CONNECT has no event.

Types

Class CL_ESH_IF_SEARCH_RESP_CONNECT has no local type.

Method Signatures

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_ORIGINAL_REQUEST	Call by reference	☑	Object reference (TYPE REF TO)	CL_ESH_FED_REQUEST_DATA		Search Request Data	20100823
2	Importing	IT_ATTR_RANGES	Call by reference	☑	Type reference (TYPE)	TREXT_ATTR_DIST_RANGES		Attribute distribution ranges	20080131
3	Importing	IT_ATTR_VALUES	Call by reference	☑	Type reference (TYPE)	TREXT_ATTR_DIST_VALUES		Attribute distribution values	20080131
4	Importing	IT_RAW_DATA	Call by reference	☑	Type reference (TYPE)	ANY		TREX result table	20080128
5	Importing	IT_TRACE	Call by reference	☑	Type reference (TYPE)	TREXT_TRACE_LINES		Trace	20130417
6	Importing	IV_NUM_RESULTS_HIGH	Call by reference	☑	Type reference (TYPE)	INT4		Number of High results	20091012
7	Importing	IV_NUM_RESULTS_MEDIUM	Call by reference	☑	Type reference (TYPE)	INT4		Number of Medium results	20091012
8	Importing	IV_RUNTIME	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_RUNTIME		Search Runtime (msec)	20081217
9	Importing	IV_TOTAL_RESULTS	Call by reference	☑	Type reference (TYPE)	INT4		Total number of hits	20080128
10	Importing	IX_ESH_IF_ENGINE	Call by reference	☑	Object reference (TYPE REF TO)	CX_ESH_IF_ENGINE		ESH Interface Exception	20100803
11	Importing	MV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20080331
12	Importing	MV_REQUEST_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request Type ID	20080331
13	Returning	RO_RESP_CONNECT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESP_CONNECT		Search Response of Connector	20080128

Method GET_INSTANCE on class CL_ESH_IF_SEARCH_RESP_CONNECT has no exception.

Method GET_RESULTS_DATA_RAW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_RAW_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Search results in raw format	20080130
2	Exporting	ET_ATTR_DIST_RAW_DATA	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_DIST_VALUES		Attributes distribution	20080228
3	Exporting	ET_ATTR_RANGES_RAW_DATA	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_DIST_RANGES		Attributes ranges	20080228

Method GET_RESULTS_DATA_RAW on class CL_ESH_IF_SEARCH_RESP_CONNECT has no exception.

Method GET_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20080331
2	Exporting	EV_REQUEST_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request Type ID	20080331

Method GET_SCOPE on class CL_ESH_IF_SEARCH_RESP_CONNECT has no exception.

Method SET_SOURCE_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_REQUEST_DATA	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_FED_REQUEST_DATA		Search Request Data	20100823

Method SET_SOURCE_REQUEST on class CL_ESH_IF_SEARCH_RESP_CONNECT has no exception.

History

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