SAP ABAP Class CL_ESH_IF_SEARCH_RESPONSES (Search Responses)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_INTERFACE (Package) Interface
Properties
Class CL_ESH_IF_SEARCH_RESPONSES  
Short Description Search Responses    
Super Class    
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
# 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_RESPONSES has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_ESH_FED_RESPONSES_BUILDER 20080813 Responses Builder
2 CL_ESH_FED_SEARCH_FEDERATER 20100915 Search Federator
3 CL_ESH_IF_SEARCH_REQUEST 20080118 Search Request
4 CL_ESH_SE_SEARCH_REQUEST 20081013 Search Request
5 CL_ESH_TREX_SEARCH 20091229 Execute an ESH Search on TREX
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CV_DIST_TYPE_ATTRIBUTE Constant Public Type reference (TYPE) ESH_E_IF_DISTRIBUTION_TYPE '3' Distribution type 20081104
2 CV_DIST_TYPE_CATEGORY Constant Public Type reference (TYPE) ESH_E_IF_DISTRIBUTION_TYPE '1' Distribution type 20081104
3 CV_DIST_TYPE_CONNECTOR Constant Public Type reference (TYPE) ESH_E_IF_DISTRIBUTION_TYPE '2' Distribution type 20081104
4 CV_DIST_TYPE_RANGE_ATTRIBUTE Constant Public Type reference (TYPE) ESH_E_IF_DISTRIBUTION_TYPE '5' Distribution type 20100913
5 CV_DIST_TYPE_RANGE_VALUE Constant Public Type reference (TYPE) ESH_E_IF_DISTRIBUTION_TYPE '6' Distribution type 20100920
6 CV_DIST_TYPE_VALUE Constant Public Type reference (TYPE) ESH_E_IF_DISTRIBUTION_TYPE '4' Distribution type 20081104
7 MS_RESPONSES_DATA Instance attribute Protected Type reference (TYPE) ESH_S_IF_RESPONSES_DATA Responses data container 20081015
Methods
# Method Level Visibility Method type Description Created on
1 ADD_RESPONSE Instance method Protected Method Add response 20080125
2 GET_CONNECTOR_STATISTICS Instance method Public Method Get connector statistics 20081204
3 GET_INSTANCE Static method Protected Method Get an instance 20080122
4 GET_MESSAGES Instance method Public Method Get search messages 20090113
5 GET_NEXT_RESPONSE Instance method Public Method Get next response 20080118
6 GET_NUMBER_OF_RESPONSES Instance method Public Method Get number of responses 20080122
7 GET_NUMBER_OF_RESULTS Instance method Public Method Get number of results of this response 20080128
8 GET_NUMBER_OF_TOTAL_RESULTS Instance method Public Method Get number of total results 20080128
9 GET_RUNTIME Instance method Public Method Get search runtime 20091012
10 GET_SCOPE_DISTRIBUTION Instance method Public Method Get distribution of results in the scope (interactive nav.) 20081015
11 HAS_NEXT_RESPONSE Instance method Public Method Has next response 20080122
12 REWIND Instance method Public Method Rewind the next cursor 20080822
13 SET_RUNTIME Instance method Protected Method Set search runtime 20091012
14 SET_SOURCE_REQUEST Instance method Protected Method Set internal source request 20100803
Events
Class CL_ESH_IF_SEARCH_RESPONSES has no event.
Types
Class CL_ESH_IF_SEARCH_RESPONSES has no local type.
Method Signatures

Method ADD_RESPONSE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_RESPONSE Call by reference Object reference (TYPE REF TO) CL_ESH_IF_SEARCH_RESPONSE Search Response 20080125

Method ADD_RESPONSE on class CL_ESH_IF_SEARCH_RESPONSES has no exception.

Method GET_CONNECTOR_STATISTICS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_STATISTICS Call by reference Type reference (TYPE) ESH_T_IF_CONNECTOR_STATISTICS Search Statistics for Connectors 20081204

Method GET_CONNECTOR_STATISTICS on class CL_ESH_IF_SEARCH_RESPONSES has no exception.

Method GET_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_RESPONSES Value transfer Object reference (TYPE REF TO) CL_ESH_IF_SEARCH_RESPONSES Search Responses 20080125

Method GET_INSTANCE on class CL_ESH_IF_SEARCH_RESPONSES has no exception.

Method GET_MESSAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MESSAGES Call by reference Type reference (TYPE) ESH_T_IF_MESSAGES Messages 20090113

Method GET_MESSAGES on class CL_ESH_IF_SEARCH_RESPONSES has no exception.

Method GET_NEXT_RESPONSE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_RESPONSE Value transfer Object reference (TYPE REF TO) CL_ESH_IF_SEARCH_RESPONSE Search Response 20080122
# Exception Resumable Description Created on
1 CX_ESH_IF_NO_MORE_ENTRIES ESH Interface Search: No more entries 20080118

Method GET_NUMBER_OF_RESPONSES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_NUMBER_OF_RESPONSES Value transfer Type reference (TYPE) INT4 Number of responses 20080122

Method GET_NUMBER_OF_RESPONSES on class CL_ESH_IF_SEARCH_RESPONSES 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 20080128

Method GET_NUMBER_OF_RESULTS on class CL_ESH_IF_SEARCH_RESPONSES 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 20080128

Method GET_NUMBER_OF_TOTAL_RESULTS on class CL_ESH_IF_SEARCH_RESPONSES has no exception.

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

Method GET_RUNTIME on class CL_ESH_IF_SEARCH_RESPONSES has no exception.

Method GET_SCOPE_DISTRIBUTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_SCOPE_DISTRIBUTION Call by reference Type reference (TYPE) ESH_T_IF_SCOPE_DISTRIBUTION Distribution of results 20081015

Method GET_SCOPE_DISTRIBUTION on class CL_ESH_IF_SEARCH_RESPONSES has no exception.

Method HAS_NEXT_RESPONSE 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_RESPONSE on class CL_ESH_IF_SEARCH_RESPONSES has no exception.

Method REWIND Signature

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

Method SET_RUNTIME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_RUNTIME Call by reference Type reference (TYPE) ESH_E_IF_RUNTIME Search Runtime (msec) 20091012

Method SET_RUNTIME on class CL_ESH_IF_SEARCH_RESPONSES 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 20100803

Method SET_SOURCE_REQUEST on class CL_ESH_IF_SEARCH_RESPONSES has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 711