SAP ABAP Class CL_ESH_TOS_SEARCH_CLIENT (Enterprise Search Client for ABAP)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_TST_AUT_OPEN_SEARCH_CLNT (Package) Open Search Client (ABAP)
Properties
Class CL_ESH_TOS_SEARCH_CLIENT  
Short Description Enterprise Search Client for ABAP    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_TST_AUT_OPEN_SEARCH_CLNT   Open Search Client (ABAP) 
Created 20100129   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_ESH_TOS_SEARCH_CLIENT has no forward declaration.
Interfaces
Class CL_ESH_TOS_SEARCH_CLIENT has no interface implemented.
Friends
Class CL_ESH_TOS_SEARCH_CLIENT has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 ATTRIBUTE_VALUE_ALL Constant Private Type reference (TYPE) STRING 'all' String 20100129
2 ATTRIBUTE_VALUE_CATEGORY Constant Private Type reference (TYPE) STRING 'category' String 20100129
3 ATTRIBUTE_VALUE_REQUEST Constant Private Type reference (TYPE) STRING 'request' String 20100129
4 LV_HTTP_DEST Instance attribute Private Type reference (TYPE) RFCDEST 20100129
5 MT_LIST_ENTRIES Instance attribute Private Type reference (TYPE) ES_T_LIST_MAP 20100129
Methods
# Method Level Visibility Method type Description Created on
1 BUILD_SEARCH_SOURCE Instance method Private Method 20100129
2 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20100129
3 GET_CATEGORY_IDS Instance method Public Method 20100129
4 GET_CATEGORY_SEARCH_SOURCE Instance method Public Method 20100129
5 GET_CATEGORY_SEARCH_SOURCES Instance method Public Method 20100129
6 GET_DEFAULT_SEARCH_SOURCE Instance method Public Method 20100129
7 GET_OPER_STAT_SEARCH_SOURCE Instance method Public Method 20100129
8 GET_REQUEST_IDS Instance method Public Method 20100129
9 GET_REQUEST_SEARCH_SOURCE Instance method Public Method 20100129
10 GET_REQUEST_SEARCH_SOURCES Instance method Public Method 20100129
11 GET_SEARCH_SOURCES Instance method Public Method 20100129
Events
Class CL_ESH_TOS_SEARCH_CLIENT has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 ES_S_CATEGORY_SSOURCES Public See coding 20100129 BEGIN OF es_s_category_ssources, cat_search_source TYPE REF TO cl_esh_tos_categ_search_src, END OF es_s_category_ssources
2 ES_S_LIST_MAP Public See coding 20100129 BEGIN OF es_s_list_map , id TYPE string, category TYPE string, entry TYPE REF TO cl_esh_tos_list_entry, END OF es_s_list_map
3 ES_S_REQUEST_O_ST_SSOURCES Public See coding 20100129 BEGIN OF es_s_request_o_st_ssources, req_search_source_o_st TYPE REF TO cl_esh_tos_req_search_src_o_st, END OF es_s_request_o_st_ssources
4 ES_S_REQUEST_SSOURCES Public See coding 20100129 BEGIN OF es_s_request_ssources, req_search_source TYPE REF TO cl_esh_tos_req_search_src, END OF es_s_request_ssources
5 ES_S_SEARCH_SOURCES Public See coding 20100129 BEGIN OF es_s_search_sources , search_source TYPE REF TO cl_esh_tos_search_source, END OF es_s_search_sources
6 ES_T_CAT_TABLE Public See coding 20100129 es_t_cat_table TYPE STANDARD TABLE OF es_s_category_ssources
7 ES_T_LIST_MAP Public See coding 20100129 es_t_list_map TYPE SORTED TABLE OF es_s_list_map WITH UNIQUE KEY id category
8 ES_T_REQ_O_ST_TABLE Public See coding 20100129 es_t_req_o_st_table TYPE STANDARD TABLE OF es_s_request_o_st_ssources
9 ES_T_REQ_TABLE Public See coding 20100129 es_t_req_table TYPE STANDARD TABLE OF es_s_request_ssources
10 ES_T_SEARCH_SOURCES Public See coding 20100129 es_t_search_sources TYPE STANDARD TABLE OF es_s_search_sources
Method Signatures

Method BUILD_SEARCH_SOURCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EO_SEARCH_SOURCE Value transfer Object reference (TYPE REF TO) CL_ESH_TOS_SEARCH_SOURCE 20100129
2 Importing IO_LIST_ENTRY Call by reference Object reference (TYPE REF TO) CL_ESH_TOS_LIST_ENTRY 20100129

Method BUILD_SEARCH_SOURCE on class CL_ESH_TOS_SEARCH_CLIENT has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_HTTP_DESTINATION Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20100129

Method CONSTRUCTOR on class CL_ESH_TOS_SEARCH_CLIENT has no exception.

Method GET_CATEGORY_IDS Signature

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

Method GET_CATEGORY_IDS on class CL_ESH_TOS_SEARCH_CLIENT has no exception.

Method GET_CATEGORY_SEARCH_SOURCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EO_CAT_SEARCH_SOURCE Value transfer Object reference (TYPE REF TO) CL_ESH_TOS_CATEG_SEARCH_SRC 20100129
2 Importing IV_CATEGORY_ID Call by reference Type reference (TYPE) STRING 20100129

Method GET_CATEGORY_SEARCH_SOURCE on class CL_ESH_TOS_SEARCH_CLIENT has no exception.

Method GET_CATEGORY_SEARCH_SOURCES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_CAT_SEARCH_SOURCES Call by reference Type reference (TYPE) ES_T_CAT_TABLE 20100129

Method GET_CATEGORY_SEARCH_SOURCES on class CL_ESH_TOS_SEARCH_CLIENT has no exception.

Method GET_DEFAULT_SEARCH_SOURCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EO_DEF_SEARCH_SOURCE Value transfer Object reference (TYPE REF TO) CL_ESH_TOS_DEFAULT_SEARCH_SRC 20100129

Method GET_DEFAULT_SEARCH_SOURCE on class CL_ESH_TOS_SEARCH_CLIENT has no exception.

Method GET_OPER_STAT_SEARCH_SOURCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_O_ST_SEARCHSOURCES Call by reference Type reference (TYPE) ES_T_REQ_O_ST_TABLE 20100129

Method GET_OPER_STAT_SEARCH_SOURCE on class CL_ESH_TOS_SEARCH_CLIENT has no exception.

Method GET_REQUEST_IDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_REQ_ID Call by reference Type reference (TYPE) STRING_TABLE 20100202

Method GET_REQUEST_IDS on class CL_ESH_TOS_SEARCH_CLIENT has no exception.

Method GET_REQUEST_SEARCH_SOURCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EO_REQ_SEARCH_SOURCE Call by reference Object reference (TYPE REF TO) CL_ESH_TOS_REQ_SEARCH_SRC 20100129
2 Importing IV_REQUEST_ID Call by reference Type reference (TYPE) STRING 20100129

Method GET_REQUEST_SEARCH_SOURCE on class CL_ESH_TOS_SEARCH_CLIENT has no exception.

Method GET_REQUEST_SEARCH_SOURCES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_REQ_SEARCH_SOURCES Call by reference Type reference (TYPE) ES_T_REQ_TABLE 20100129

Method GET_REQUEST_SEARCH_SOURCES on class CL_ESH_TOS_SEARCH_CLIENT has no exception.

Method GET_SEARCH_SOURCES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_SEARCH_SOURCES Call by reference Type reference (TYPE) ES_T_SEARCH_SOURCES 20100129

Method GET_SEARCH_SOURCES on class CL_ESH_TOS_SEARCH_CLIENT has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 730