SAP ABAP Class CL_ESH_IF_SEARCH_RESPONSE (Search Response)

Hierarchy

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

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_ESH_IF_SEARCH_RESP_ASYNC	Search Response of Aynchronous Search	20080118
2	Inheritance (c INHERITING FROM c_ref)	CL_ESH_IF_SEARCH_RESP_CONNECT	Search Response of Connector	20080118
3	Inheritance (c INHERITING FROM c_ref)	CL_ESH_IF_SEARCH_RESP_FEDERATE	Search Response of Federated Search	20080118

Properties

Class	CL_ESH_IF_SEARCH_RESPONSE
Short Description	Search Response
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_INTERFACE	Interface
Created	20080117	SAP
Last change	20140121	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_IF_SEARCH_RESPONSE has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_FED_OBJECT_PACKER	☐	20081212	Search Entity Accessor
2	CL_ESH_FED_RESPONSE_ENRICHER	☐	20100727	Response Enricher
3	CL_ESH_IF_SEARCH_RESPONSES	☐	20081204	Search Responses
4	CL_ESH_SE_SEARCH_REQUEST	☐	20081016	Search Request

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_CONNECTOR_STATISTICS	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_T_IF_CONNECTOR_STATISTICS		Search statistics for connectors	20081203
2	MT_GROUPED_RESULTS	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_T_IF_GROUPED_RESULT_DATA		Grouped result lists - holds results per connector (request)	20080811
3	MT_MERGE_INDEX	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_T_IF_MERGE_INDEX_TABLE		Merge index table for merged search results	20081212
4	MT_TRACE	Instance attribute	Protected	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20130417
5	MV_LAST_FETCHED_RESULT_NUMBER	Instance attribute	Protected	☐	Type reference (TYPE)	INT4		Natural number	20081212
6	MX_ESH_IF_ENGINE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CX_ESH_IF_ENGINE		ESH interface exception	20080626

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_ATTRIBUTE_DISTRIBUTIONS	Instance method	Public	Method	Get attribute distribution	20081105
2	GET_CONNECTORS	Instance method	Public	Method	Get involved connectors	20081013
3	GET_CONNECTOR_STATISTICS	Instance method	Public	Method	Get search statistic for one involved connector	20081203
4	GET_ENGINE_TRACE	Instance method	Public	Method	Get engine trace	20130417
5	GET_EXCEPTION	Instance method	Public	Method	Get exception	20080626
6	GET_NEXT_RESULT	Instance method	Public	Method	Get next result	20080122
7	GET_NO_OF_RESULTS_BY_CONNECTOR	Instance method	Public	Method	Get number of results by connector	20081013
8	GET_NUMBER_OF_RESULTS	Instance method	Public	Method	Get number of results of this response	20080118
9	GET_NUMBER_OF_TOTAL_RESULTS	Instance method	Public	Method	Get number of total results	20080118
10	HAS_NEXT_RESULT	Instance method	Public	Method	Has next result	20080122
11	REWIND	Instance method	Public	Method	Rewind cursor	20080822
12	SET_CONNECTOR_STATISTICS	Instance method	Protected	Method	Set/Change a search statistic for one involved connector	20081203
13	SET_EXCEPTION	Instance method	Protected	Method	Set exception	20080626

Events

Class CL_ESH_IF_SEARCH_RESPONSE has no event.

Types

Class CL_ESH_IF_SEARCH_RESPONSE has no local type.

Method Signatures

Method GET_ATTRIBUTE_DISTRIBUTIONS 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

Method GET_ATTRIBUTE_DISTRIBUTIONS on class CL_ESH_IF_SEARCH_RESPONSE has no exception.

Method GET_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_IF_SEARCH_CONN_DESCRS		Search Connectors	20081013

Method GET_CONNECTORS on class CL_ESH_IF_SEARCH_RESPONSE has no exception.

Method GET_CONNECTOR_STATISTICS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_STATISTICS	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_CONNECTOR_STATISTICS		Search Statistic for one Connector	20081203
2	Importing	IV_CONNECTOR_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20081203
3	Importing	IV_REQUEST_TYPE_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request Type ID	20081217

Method GET_CONNECTOR_STATISTICS on class CL_ESH_IF_SEARCH_RESPONSE has no exception.

Method GET_ENGINE_TRACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TRACE	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20130417

Method GET_ENGINE_TRACE on class CL_ESH_IF_SEARCH_RESPONSE has no exception.

Method GET_EXCEPTION Signature

Method GET_EXCEPTION on class CL_ESH_IF_SEARCH_RESPONSE has no parameter.

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

Method GET_NEXT_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20080122

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_NO_MORE_ENTRIES	☐	ESH Interface Search: No more entries	20080122

Method GET_NO_OF_RESULTS_BY_CONNECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20081013
2	Returning	RV_NUMBER_OF_RESULTS	Value transfer	☐	Type reference (TYPE)	INT4		Natural number	20081013

Method GET_NO_OF_RESULTS_BY_CONNECTOR on class CL_ESH_IF_SEARCH_RESPONSE has no exception.

Method GET_NUMBER_OF_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NUMBER_OF_RESULTS	Value transfer	☐	Type reference (TYPE)	INT4		Number of results	20080118

Method GET_NUMBER_OF_RESULTS on class CL_ESH_IF_SEARCH_RESPONSE has no exception.

Method GET_NUMBER_OF_TOTAL_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NUMBER_OF_RESULTS	Value transfer	☐	Type reference (TYPE)	INT4		Number of results	20080118

Method GET_NUMBER_OF_TOTAL_RESULTS on class CL_ESH_IF_SEARCH_RESPONSE has no exception.

Method HAS_NEXT_RESULT Signature

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

Method HAS_NEXT_RESULT on class CL_ESH_IF_SEARCH_RESPONSE has no exception.

Method REWIND Signature

Method REWIND on class CL_ESH_IF_SEARCH_RESPONSE has no parameter.
Method REWIND on class CL_ESH_IF_SEARCH_RESPONSE has no exception.

Method SET_CONNECTOR_STATISTICS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONNECTOR_STATISTICS	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_CONNECTOR_STATISTICS		Search Statistic for one Connector	20081203
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20081203
3	Importing	IV_REQUEST_TYPE_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request Type ID	20081217

Method SET_CONNECTOR_STATISTICS on class CL_ESH_IF_SEARCH_RESPONSE has no exception.

Method SET_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IX_ESH_IF_ENGINE	Call by reference	☐	Object reference (TYPE REF TO)	CX_ESH_IF_ENGINE			20080626

Method SET_EXCEPTION on class CL_ESH_IF_SEARCH_RESPONSE has no exception.

History

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