SAP ABAP Class CL_ESH_IF_SEARCH_REQUEST (Search Request)
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 Interface implementation (CLASS c. INTERFACES i_ref)  IF_ESH_IF_ASYNCHRONOUS_SEARCH Interface for asynchronous search 20081001
Properties
Class CL_ESH_IF_SEARCH_REQUEST  
Short Description Search Request    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_ENG_INTERFACE   Interface 
Created 20080116   SAP 
Last change 20141121    
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)
2 CL_ESH_IF_SEARCH_REQUEST Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 IF_ESH_SE_RUNTIME_DATA Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
# Interface Abstract Final Description Created on
1 IF_ESH_IF_ASYNCHRONOUS_SEARCH Interface for asynchronous search 20081001
Friends
# Friend Modeled only Created on Description
1 CL_ESH_IF_SEARCH_RESULT 20130219 Search Result
2 CL_ESH_SE_SEARCH_DEBUGGING 20100607 Search Debugger
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_CONTENT_TYPE_AND Constant Public Type reference (TYPE) ESH_E_IF_CONTENT_TYPE 'A' All terms are to be concatenated by AND 20110420
2 GC_CONTENT_TYPE_CONTENT Constant Public Type reference (TYPE) ESH_E_IF_CONTENT_TYPE 'C' Search is executed over the whole text (content) 20110420
3 GC_FOLLOW_UP_TYPE_PAGE_SIZE Constant Public Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE 'P' Change page size 20100409
4 GC_FOLLOW_UP_TYPE_PAGING Constant Public Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE 'N' Paging: Go to next page 20091218
5 GC_FOLLOW_UP_TYPE_PAGING_BACK Constant Public Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE 'B' Paging: Go to previous page 20100409
6 GC_FOLLOW_UP_TYPE_PAGING_FIRST Constant Public Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE '1' Paging: Go to first page 20100409
7 GC_FOLLOW_UP_TYPE_REFINEMENT Constant Public Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE 'F' Refinement: Narrow down 20091218
8 GC_FOLLOW_UP_TYPE_REFINEM_UNDO Constant Public Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE 'U' Refinement: Narrow up 20100409
9 GC_FOLLOW_UP_TYPE_REL_REQ Constant Public Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE 'R' Related request 20091218
10 GC_FOLLOW_UP_TYPE_SORT_ASC Constant Public Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE 'A' Sort ascending 20100409
11 GC_FOLLOW_UP_TYPE_SORT_DESC Constant Public Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE 'D' Sort descending 20100409
12 GC_FOLLOW_UP_TYPE_STANDARD Constant Public Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE '' Standard (no predecessor) 20091218
13 GC_FOLLOW_UP_TYPE_SUB_REQ Constant Public Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE 'S' Subrequest 20091218
14 GC_FOLLOW_UP_TYPE_SWITCH_FUZZY Constant Public Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE 'Z' Switch to fuzzy mode 20110420
15 GC_MODE_AUTHORIZATION_DEBUG Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_MODE 'D' Authorization debugging 20091216
16 GC_MODE_INTERNAL_QUERY Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_MODE 'I' Internal query 20100203
17 GC_MODE_OTHERS Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_MODE 'O' Others 20091216
18 GC_MODE_PERFORMANCE Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_MODE 'P' Performance measurement 20091216
19 GC_MODE_REEXECUTION Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_MODE 'E' Re-Execution 20091216
20 GC_MODE_STANDARD_REQUEST Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_MODE '' Functional search request 20091216
21 GC_MODE_TEST_SEARCH Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_MODE 'T' Test search request 20091218
22 GC_MODE_UNIT_TEST Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_MODE 'U' Unit test execution 20100127
23 GC_MODE_VALUE_HELP Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_MODE 'V' Value help search request 20091218
24 GC_MODE_WHERE_FOUND Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_MODE 'W' Where-found analysis 20100810
25 GC_SEARCH_METHOD_FEDERATED Constant Public Type reference (TYPE) ESH_D_IF_SEARCH_METHOD 'SYNCHRON' Synchronous 20081212
26 GC_SEARCH_METHOD_SYNCHRONOUS Constant Public Type reference (TYPE) ESH_D_IF_SEARCH_METHOD 'FEDERATED' Federated 20081212
27 GC_SEARCH_MODE_EXACT Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_MODE 'E' Search mode exact 20110420
28 GC_SEARCH_MODE_FUZZY Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_MODE 'F' Search mode fuzzy 20110420
29 GC_SEARCH_MODE_LINGUISTIC Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_MODE 'L' Search mode linguistic 20110420
30 GC_SEARCH_MODE_SIMILARITY Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_MODE 'I' Search mode similarity 20110420
31 GC_SUGG_REQUEST_FIRST Static Attribute Public Type reference (TYPE) ESH_E_IF_SUGGESTED_REQUEST '03' Data element for suggested request type: First 20080226
32 GC_SUGG_REQUEST_LAST Static Attribute Public Type reference (TYPE) ESH_E_IF_SUGGESTED_REQUEST '04' Data element for suggested request type: Last 20080226
33 GC_SUGG_REQUEST_NEXT Static Attribute Public Type reference (TYPE) ESH_E_IF_SUGGESTED_REQUEST '01' Data element for suggested request type: Next 20080226
34 GC_SUGG_REQUEST_ORIGINAL Static Attribute Public Type reference (TYPE) ESH_E_IF_SUGGESTED_REQUEST '08' Data element for suggested request type: Related 20080227
35 GC_SUGG_REQUEST_PREVIOUS Static Attribute Public Type reference (TYPE) ESH_E_IF_SUGGESTED_REQUEST '02' Data element for suggested request type: Previous 20080226
36 GC_SUGG_REQUEST_RANGES Static Attribute Public Type reference (TYPE) ESH_E_IF_SUGGESTED_REQUEST '06' Data element for suggested request type: Ranges 20080226
37 GC_SUGG_REQUEST_RELATED Static Attribute Public Type reference (TYPE) ESH_E_IF_SUGGESTED_REQUEST '07' Data element for suggested request type: Related 20080226
38 GC_SUGG_REQUEST_VALUES Static Attribute Public Type reference (TYPE) ESH_E_IF_SUGGESTED_REQUEST '05' Data element for suggested request type: Values 20080226
39 GC_URL_TYPE_OPEN_SEARCH Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_URL_TYPE 'OPEN_SEARCH' OpenSearch 20090216
40 GC_URL_TYPE_SEARCH_UI Constant Public Type reference (TYPE) ESH_E_IF_SEARCH_URL_TYPE 'SEARCH_UI' Search UI 20090216
41 MO_RESPONSES_DELEGATION Instance attribute Private Object reference (TYPE REF TO) CL_ESH_IF_SEARCH_RESPONSES Search responses 20090128
42 MR_FEDERATER Instance attribute Private Object reference (TYPE REF TO) CL_ESH_FED_SEARCH_FEDERATER Search federator 20081001
43 MR_QUERY_LOGGER Instance attribute Private Object reference (TYPE REF TO) CL_ESH_QL_QUERY_LOGGING Query logging 20091005
44 MR_QUERY_TRANSFORMATOR Instance attribute Private Object reference (TYPE REF TO) CL_ESH_FED_QUERY_TRANSFORMATOR Query transformator 20090810
45 MR_REQUEST_DATA Instance attribute Private Object reference (TYPE REF TO) CL_ESH_FED_REQUEST_DATA Search request data 20081001
46 MT_MESSAGES Instance attribute Private Type reference (TYPE) ESH_T_IF_MESSAGES Messages 20090113
47 MV_APPLIANCE_DESTINATION Instance attribute Private Type reference (TYPE) RFCDEST Logical destination (specified in function call) 20081211
48 MV_EXEC_MODE Instance attribute Private Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_MODE Search execution mode 20091216
49 MV_FOLLOW_UP_QUERY_TYPE Instance attribute Private Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE Follow-up query type 20091218
50 MV_PREDECESSOR_QUERY_ID Instance attribute Private Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_ID ID of original query 20091218
51 MV_QUERY_ID_FOR_LOG Instance attribute Private Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_ID Search execution ID 20091216
52 MV_SEARCH_SESSION_ID Instance attribute Private Type reference (TYPE) ESH_E_IF_SEARCH_SESSION_ID Search session ID 20091218
53 MV_TIMEOUT Instance attribute Private Type reference (TYPE) ESH_E_IF_TIMEOUT Timeout 20081212
54 MX_LOCAL_EXCEPTION Instance attribute Private Object reference (TYPE REF TO) CX_ESH_IF_ENGINE Local exception 20090217
Methods
# Method Level Visibility Method type Description Created on
1 ADD_FREESTYLE_ATTRIBUTE Instance method Public Method Add a freestyle attribute (optional / = request attributes) 20100720
2 ADD_MESSAGES_TO_RESPONSES Instance method Private Method Add messages to the responses object 20090113
3 ADD_SEARCH_ATTRIBUTE Instance method Public Method Add a search attribute condition 20080117
4 ADD_SEARCH_SCOPE Instance method Public Method Add a search scope (AND-dependency inside one scope) 20080117
5 ADD_SEARCH_SEMANTICS Instance method Public Method Add a semantics condition 20090318
6 ADD_SEARCH_TIPS_TO_MESSAGES Instance method Private Method Add the search tips to the messages 20090113
7 ADJUST_INTERACTIVE_NAVIGATION Instance method Public Method Adjust interactive navigation settings 20090319
8 CLONE Instance method Public Method Clone 20081202
9 CONSTRUCTOR Instance method Public Constructor Constructor 20080117
10 DELEGATE_SEARCH_TO_APPLIANCE Instance method Private Method Delegate search to ES appliance (send RFC search request) 20081211
11 GET_ATTRIBUTE_SUGGESTIONS Instance method Public Method Get suggestions for a search input 20121108
12 GET_ATTRIBUTE_VALUE_LIST Instance method Public Method Get value list for value help 20090114
13 GET_CURRENT_SEARCH_ID Instance method Public Method Get ID of current search 20091110
14 GET_MAX_NUMBER_OF_RESULTS Instance method Public Method Get page upper limit 20081017
15 GET_RESPONSES_ASYNC Instance method Public Method 20081212
16 GET_SCOPE Instance method Public Method Get the current search scope 20081119
17 GET_SEARCH_TERMS Instance method Public Method Get search terms - a serialized version if the request query 20081212
18 GET_SEARCH_TEXT Instance method Public Method Get the textual search string 20081017
19 GET_SEARCH_URL Instance method Public Method Get the search URL of the request (search UI or OpenSearch) 20090216
20 GET_START_INDEX Instance method Public Method Get page lower limit 20081017
21 GET_SUGGESTED_REQUESTS Instance method Protected Method Get suggested requests - obsolete IF_SE 20080117
22 GET_SUGGESTIONS Instance method Public Method Get suggestions for a search input 20090320
23 GET_TIMEOUT Instance method Public Method Get search timeout (sec) 20090320
24 HAS_NEW_RESPONSES_ASYNC Instance method Public Method 20081212
25 IS_FINISHED_ASYNC Instance method Public Method 20081212
26 SEARCH Instance method Public Method Execute search 20080117
27 SEARCH_ASYNCHRONOUS Instance method Public Method 20081212
28 SEARCH_DISTINCT Instance method Public Method Get distinct result tables for certain attributes 20101130
29 SEARCH_DUPLICATES Instance method Private Method NOT YET IMPLEMENTED 20130222
30 SEARCH_FEDERATED Instance method Public Method Execute federated search 20080117
31 SET_ATTRIBUTE_FOR_GET_CONTENT Instance method Public Method Retrieve the textual content of the request attribute 20100224
32 SET_INTERNAL_QUERY Instance method Public Method Set internal query 20080222
33 SET_MAX_NUMBER_OF_RESULTS Instance method Public Method Set page upper limit 20080118
34 SET_QUERY_PARTS Instance method Public Method Set query options via query parts 20090814
35 SET_RULESET_ID Instance method Private Method Set Ruleset ID for duplicate search (on HANA only) 20130222
36 SET_SEARCH_DEBUGGER Instance method Protected Method Set object for search debugging 20100607
37 SET_SEARCH_LANGUAGE Instance method Public Method Set search language (optional - default is all languages) 20090427
38 SET_SEARCH_MODE Instance method Public Method Set the search mode 20080222
39 SET_SEARCH_SCOPE Instance method Public Method Set (overwrite) search scope 20081114
40 SET_SEARCH_TERMS Instance method Protected Method Obsolete - use set_search_text 20080117
41 SET_SEARCH_TEXT Instance method Public Method Add search text 20080122
42 SET_SEARCH_TYPE Instance method Public Method Set type of search: Initial/ Follow up 20091216
43 SET_SEARCH_VALIDITY_BY_DATE Instance method Public Method Set search validity by date 20080611
44 SET_SORT_ATTRIBUTES Instance method Public Method Set the sorting attributes for the result list 20080222
45 SET_START_INDEX Instance method Public Method Set page lower limit 20080118
46 SET_TIMEOUT Instance method Public Method Set search timeout (sec) 20081119
47 SET_TRACING_PARAMETERS Instance method Public Method Obsolete 20080620
48 SET_UI_TECHS_FOR_LINKS Instance method Public Method Overwrite the UI techs. for navigation targets (optional) 20100719
49 _FIND_MATCH_OF_TERM Instance method Private Method Find match for term 20130508
Events
Class CL_ESH_IF_SEARCH_REQUEST has no event.
Types
Class CL_ESH_IF_SEARCH_REQUEST has no local type.
Method Signatures

Method ADD_FREESTYLE_ATTRIBUTE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NAME Call by reference Type reference (TYPE) STRING 20100720

Method ADD_FREESTYLE_ATTRIBUTE on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method ADD_MESSAGES_TO_RESPONSES 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 20090113
2 Importing IT_MESSAGES Call by reference Type reference (TYPE) ESH_T_IF_MESSAGES Messages 20090113

Method ADD_MESSAGES_TO_RESPONSES on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method ADD_SEARCH_ATTRIBUTE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_SELECT_OPTIONS Call by reference Type reference (TYPE) ANY TABLE 20080222
2 Importing IV_CONTENT_TYPE Call by reference Type reference (TYPE) ESH_E_IF_CONTENT_TYPE Content Type 20110420
3 Importing IV_NAME Call by reference Type reference (TYPE) STRING 20080121
4 Importing IV_SEARCH_MODE Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_MODE Search Mode 20110420
5 Importing IV_VALUE Call by reference Type reference (TYPE) STRING 20080121

Method ADD_SEARCH_ATTRIBUTE on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method ADD_SEARCH_SCOPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CATEGORY_ID Call by reference Type reference (TYPE) ESH_E_OM_CATEGORY Category 20080121
2 Importing IV_CONNECTOR_ID Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_CONNECTOR_ID Search Connector ID 20080121
3 Importing IV_KEYWORD Call by reference Type reference (TYPE) ESH_E_IF_KEYWORD Keyword 20081216
4 Importing IV_LOCAL_SEARCH Call by reference Type reference (TYPE) ESH_E_IF_DEFAULT_FLAG Only data from the local system 20080401
5 Importing IV_REQUEST_TYPE_ID Call by reference Type reference (TYPE) ESH_E_IF_REQUEST_TYPE_ID Request Type ID 20080123
6 Importing IV_TEMPLATE_ID Call by reference Type reference (TYPE) ESH_E_IF_TEMPLATE_ID Search Connector Template ID 20080121
# Exception Resumable Description Created on
1 ERROR Internal error 20080401
2 NOT_SEARCHABLE The scope is not searchable 20080401

Method ADD_SEARCH_SEMANTICS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LOW Call by reference Type reference (TYPE) ESH_E_IF_ATTRIBUTE_VALUE Value 20090318
2 Importing IV_SEMANTICS_CODE Call by reference Type reference (TYPE) ESH_E_IF_CONSTR_NAME Constraint name 20090318
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20100105

Method ADD_SEARCH_TIPS_TO_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
2 Importing IT_SEARCH_TIPS Call by reference Type reference (TYPE) STRING_TABLE Table of Strings 20090113

Method ADD_SEARCH_TIPS_TO_MESSAGES on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method ADJUST_INTERACTIVE_NAVIGATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_MAIN_SWITCH Call by reference Type reference (TYPE) ESH_E_IF_INAV_MAIN_SWITCH Interactive Navigation Main Switch 20090319
2 Importing IV_MAX_NUM_VALUES Call by reference Type reference (TYPE) ESH_E_IF_INAV_MAX_NUM_VALUES Interactive Navigation - Maximum Number of Values 20090319
3 Importing IV_OPT_NUM_VALUES Call by reference Type reference (TYPE) ESH_E_IF_INAV_OPT_NUM_VALUES Interactive Navigation - Optimum Number of Values 20090319

Method ADJUST_INTERACTIVE_NAVIGATION on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method CLONE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_REQUEST Value transfer Object reference (TYPE REF TO) CL_ESH_IF_SEARCH_REQUEST Search Request 20081202

Method CLONE on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_ESH_IF_SEARCH_REQUEST has no parameter.
Method CONSTRUCTOR on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method DELEGATE_SEARCH_TO_APPLIANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_EXECUTION_CONTROL Call by reference Type reference (TYPE) ESH_S_IF_SEARCH_EXEC_CONTROL Control Search Request Processing (timeout, ...) 20081212
2 Returning RO_RESPONSES Value transfer Object reference (TYPE REF TO) CL_ESH_IF_SEARCH_RESPONSES Search Responses 20081212
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20081211

Method GET_ATTRIBUTE_SUGGESTIONS 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 20130523
2 Exporting ET_SUGGESTIONS Call by reference Type reference (TYPE) ESH_T_IF_ATTRIBUTE_SUGGESTIONS Suggestions for a search input 20121108
3 Exporting EV_RUNTIME Call by reference Type reference (TYPE) ESH_E_IF_RUNTIME Search Runtime (msec) 20131113
4 Importing IT_ATTRIBUTES Call by reference Type reference (TYPE) ESH_T_IF_ATTR_NAMES Table of Attribute Names 20130319
5 Importing IV_SEARCH_TERMS Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_STRING Search String 20121108
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20121108

Method GET_ATTRIBUTE_VALUE_LIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_VALUE_LIST Call by reference Type reference (TYPE) ESH_T_IF_ATTR_VALUE_LIST Attribute Value List for Value Help 20090114
2 Exporting EV_NO_OF_TOTAL_HITS Call by reference Type reference (TYPE) ESH_E_IF_NO_OF_TOTAL_RESULTS Number of total results 20090204
3 Importing IT_ATTRIBUTES Call by reference Type reference (TYPE) ESH_T_IF_ATTR_NAMES Table of Attribute Names 20090114
4 Importing IT_ATTRIBUTE_CONDITIONS Call by reference Type reference (TYPE) ESH_T_IF_ATTRIBUTE_CONDITIONS Attribute Conditions 20100802
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20090114

Method GET_CURRENT_SEARCH_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_ID Value transfer Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_ID Search Execution ID 20091110

Method GET_CURRENT_SEARCH_ID on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method GET_MAX_NUMBER_OF_RESULTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_MAX_NUMBER_OF_RESULTS Value transfer Type reference (TYPE) INT4 Natural number 20081017

Method GET_MAX_NUMBER_OF_RESULTS on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method GET_RESPONSES_ASYNC Signature

Method GET_RESPONSES_ASYNC on class CL_ESH_IF_SEARCH_REQUEST has no parameter.
Method GET_RESPONSES_ASYNC on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method GET_SCOPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_SCOPE Call by reference Type reference (TYPE) ESH_T_IF_SCOPE Scope of Search Request 20081119

Method GET_SCOPE on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method GET_SEARCH_TERMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_WITH_SCOPE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20100211
2 Returning RV_SEARCH_TERMS Value transfer Type reference (TYPE) STRING 20081212
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20081212

Method GET_SEARCH_TEXT Signature

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

Method GET_SEARCH_TEXT on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method GET_SEARCH_URL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SEARCH_URL_TYPE Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_URL_TYPE GC_URL_TYPE_SEARCH_UI Search URL Type (Search UI, Open Search, ...) 20090216
2 Returning RV_SEARCH_URL Value transfer Type reference (TYPE) STRING 20090216
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20090217

Method GET_START_INDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_START_INDEX Value transfer Type reference (TYPE) INT4 Natural number 20081017

Method GET_START_INDEX on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method GET_SUGGESTED_REQUESTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning ET_SUGGESTED_REQUESTS Value transfer Type reference (TYPE) ESH_T_IF_SUGG_REQUEST_REQUEST Table type for ESH_S_IF_SUGG_REQUEST_REQUEST 20080226
2 Importing IT_SUGGESTED_REQUEST_TYPES Call by reference Type reference (TYPE) ESH_T_IF_SUGGESTED_REQUEST Table type for suggested request type 20080226

Method GET_SUGGESTED_REQUESTS on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method GET_SUGGESTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_SUGGESTIONS Call by reference Type reference (TYPE) ESH_T_IF_SUGGESTIONS Suggestions for a search input 20090320
2 Importing IV_NUMBER_OF_SUGGESTIONS Call by reference Type reference (TYPE) ESH_E_IF_NO_OF_RESULTS Number of Results 20100401
3 Importing IV_SEARCH_TERMS Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_STRING Search String 20090320
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20090320

Method GET_TIMEOUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_TIMEOUT Value transfer Type reference (TYPE) ESH_E_IF_TIMEOUT Search Timeout in sec 20090320

Method GET_TIMEOUT on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method HAS_NEW_RESPONSES_ASYNC Signature

Method HAS_NEW_RESPONSES_ASYNC on class CL_ESH_IF_SEARCH_REQUEST has no parameter.
Method HAS_NEW_RESPONSES_ASYNC on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method IS_FINISHED_ASYNC Signature

Method IS_FINISHED_ASYNC on class CL_ESH_IF_SEARCH_REQUEST has no parameter.
Method IS_FINISHED_ASYNC on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SEARCH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_COUNT_ONLY Call by reference Type reference (TYPE) ABAP_BOOL Count only 20080131
2 Importing IV_ENGINE_TRACE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Enable engine trace 20130417
3 Importing IV_RETURN_WHY_FOUND Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Return hit locations 20101214
4 Returning RO_RESPONSES Value transfer Object reference (TYPE REF TO) CL_ESH_IF_SEARCH_RESPONSES Search Responses 20080122
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20080318

Method SEARCH_ASYNCHRONOUS Signature

Method SEARCH_ASYNCHRONOUS on class CL_ESH_IF_SEARCH_REQUEST has no parameter.
Method SEARCH_ASYNCHRONOUS on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SEARCH_DISTINCT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_ATTRIBUTES Call by reference Type reference (TYPE) ESH_T_IF_ATTR_NAMES Table of Attribute Names 20101130
2 Importing IT_ATTRIBUTE_CONDITIONS Call by reference Type reference (TYPE) ESH_T_IF_ATTRIBUTE_CONDITIONS Attribute Conditions 20101130
3 Importing IV_RETURN_WHY_FOUND Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20121024
4 Returning RO_RESPONSES Value transfer Object reference (TYPE REF TO) CL_ESH_IF_SEARCH_RESPONSES 20101130
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20101130

Method SEARCH_DUPLICATES 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 20130222
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20130222

Method SEARCH_FEDERATED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_COUNT_ONLY Call by reference Type reference (TYPE) ABAP_BOOL Count only 20090223
2 Importing IV_RETURN_WHY_FOUND Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Return hit locations 20101214
3 Importing IV_SORT_BY_RANK Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Sort by rank value instead of round robin 20090910
4 Returning RO_RESPONSES Value transfer Object reference (TYPE REF TO) CL_ESH_IF_SEARCH_RESPONSES Search Responses 20081015
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20090108

Method SET_ATTRIBUTE_FOR_GET_CONTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_HIGHLIGHT_TERMS Call by reference Type reference (TYPE) STRING Terms to be highlighted in the content 20100224
2 Importing IV_REQUEST_ATTRIBUTE_ID Call by reference Type reference (TYPE) ESH_E_IF_ATTRIBUTE_NAME Attribute Name 20100224

Method SET_ATTRIBUTE_FOR_GET_CONTENT on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_INTERNAL_QUERY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_SEARCH_QUERY Call by reference Type reference (TYPE) TREXT_QUERY_ENTRIES Search query 20080222

Method SET_INTERNAL_QUERY on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_MAX_NUMBER_OF_RESULTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NUMBER_OF_RESULTS Call by reference Type reference (TYPE) INT4 20 End index 20080118

Method SET_MAX_NUMBER_OF_RESULTS on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_QUERY_PARTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_ROOT_QUERY_PART Call by reference Object reference (TYPE REF TO) CL_ESH_IF_QUERY_PART Root Query Part 20090814

Method SET_QUERY_PARTS on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_RULESET_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_RULESET_ID Call by reference Type reference (TYPE) ESH_E_IF_RULESET_ID Ruleset ID for duplicate search 20130222
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20130222

Method SET_SEARCH_DEBUGGER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_SEARCH_DEBUGGER Call by reference Object reference (TYPE REF TO) CL_ESH_SE_SEARCH_DEBUGGING Search Debugger 20100607

Method SET_SEARCH_DEBUGGER on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_SEARCH_LANGUAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LANGUAGE Call by reference Type reference (TYPE) LAISO 20090427

Method SET_SEARCH_LANGUAGE on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_SEARCH_MODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FUZZY_SIMILARITY Call by reference Type reference (TYPE) ESH_E_IF_FUZZY_SIMILARITY 7000 Fuzzy Similarity 0..10000 20090727
2 Importing IV_SEARCH_OPTIONS Call by reference Type reference (TYPE) ESH_E_FED_SEARCH_OPTIONS Search Options 20131205
3 Importing IV_TERM_ACTION Call by reference Type reference (TYPE) TREXD_TERM_ACTION Term action (Exact, fuzzy) 20080222

Method SET_SEARCH_MODE on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_SEARCH_SCOPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CATEGORY_ID Call by reference Type reference (TYPE) ESH_E_OM_CATEGORY Category 20081114
2 Importing IV_CONNECTOR_ID Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_CONNECTOR_ID Search Connector ID 20081114
3 Importing IV_KEYWORD Call by reference Type reference (TYPE) ESH_E_IF_KEYWORD Keyword 20081216
4 Importing IV_LOCAL_SEARCH Call by reference Type reference (TYPE) ESH_E_IF_DEFAULT_FLAG Only data from the local system 20081114
5 Importing IV_REQUEST_TYPE_ID Call by reference Type reference (TYPE) ESH_E_IF_REQUEST_TYPE_ID Request Type ID 20081114
6 Importing IV_TEMPLATE_ID Call by reference Type reference (TYPE) ESH_E_IF_TEMPLATE_ID Search Connector Template ID 20081114
# Exception Resumable Description Created on
1 ERROR Internal error 20081114
2 NOT_SEARCHABLE The scope is not searchable 20081114

Method SET_SEARCH_TERMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SEARCH_TERMS Call by reference Type reference (TYPE) STRING 20080118

Method SET_SEARCH_TERMS on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_SEARCH_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TEXT Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_STRING Search String 20080122

Method SET_SEARCH_TEXT on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_SEARCH_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_EXECUTION_MODE Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_MODE Search Execution Mode (Functional / Special) 20091216
2 Importing IV_FOLLOW_UP_QUERY_TYPE Call by reference Type reference (TYPE) ESH_E_IF_FOLLOW_UP_QUERY_TYPE In case of Follow-Up Query: Follow-Up Query Type 20091218
3 Importing IV_PREDECESSOR_QUERY_ID Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_EXEC_ID In case of Follow-Up Query: ID of Predecessor Query 20091216
4 Importing IV_SEARCH_SESSION_ID Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_SESSION_ID Search Session ID 20091218

Method SET_SEARCH_TYPE on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_SEARCH_VALIDITY_BY_DATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_DATE Call by reference Type reference (TYPE) DATUM Date 20080611

Method SET_SEARCH_VALIDITY_BY_DATE on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_SORT_ATTRIBUTES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_SORT_ATTRIBUTES Call by reference Type reference (TYPE) TREXT_SORT_ATTRIBUTES Sort attributes 20080222

Method SET_SORT_ATTRIBUTES on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_START_INDEX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_START_INDEX Call by reference Type reference (TYPE) INT4 1 Start index 20080118

Method SET_START_INDEX on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_TIMEOUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TIMEOUT Call by reference Type reference (TYPE) ESH_E_IF_TIMEOUT Search Timeout in sec 20081119

Method SET_TIMEOUT on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_TRACING_PARAMETERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_GET_RT_KERNEL_NET Call by reference Type reference (TYPE) ESH_E_CO_BOOLEAN OBSOLETE 20080620
2 Importing IV_GET_RT_QUERY_GROSS Call by reference Type reference (TYPE) ESH_E_CO_BOOLEAN OBSOLETE 20080620
3 Importing IV_GET_RT_TREX_GROSS Call by reference Type reference (TYPE) ESH_E_CO_BOOLEAN OBSOLETE 20080620
4 Importing IV_LOG_REQUEST Call by reference Type reference (TYPE) ESH_E_CO_BOOLEAN OBSOLETE 20080620
5 Importing IV_LOG_REQUEST_INTERNAL_REPRES Call by reference Type reference (TYPE) ESH_E_CO_BOOLEAN OBSOLETE 20080630
6 Importing IV_SEARCH_REQUEST_ID Call by reference Type reference (TYPE) CHAR32 OBSOLETE 20080922

Method SET_TRACING_PARAMETERS on class CL_ESH_IF_SEARCH_REQUEST has no exception.

Method SET_UI_TECHS_FOR_LINKS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_UI_TECHS Call by reference Type reference (TYPE) ESH_T_IF_TARGET_UI_TYPES UI Technology list for navigation targets 20100719
2 Importing IV_BUILD_FOR_ALL_TECHS Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Build all targets for each navigation action 20130325
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20100720

Method _FIND_MATCH_OF_TERM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_MATCH Call by reference Type reference (TYPE) MATCH_RESULT Match with Regular Expression 20130508
2 Importing IV_TERM Call by reference Type reference (TYPE) STRING 20130508
3 Importing IV_TRY_FUZZY Call by reference Type reference (TYPE) ABAP_BOOL 20130508
4 Importing IV_VALUE Call by reference Type reference (TYPE) STRING 20130508

Method _FIND_MATCH_OF_TERM on class CL_ESH_IF_SEARCH_REQUEST has no exception.
History
Last changed by/on SAP  20141121 
SAP Release Created in 711