SAP ABAP Class CL_ESH_CO_SEARCH_LOGGING (OBSOLETE: Search Request Logging)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_QUERY_LOGGING (Package) Query Logging
Properties
Class CL_ESH_CO_SEARCH_LOGGING  
Short Description OBSOLETE: Search Request Logging    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_ENG_QUERY_LOGGING   Query Logging 
Created 20080623   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 CL_ESH_IF_SEARCH_REQUEST Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
2 CL_ESH_SE_SEARCH_REQUEST Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
Interfaces
Class CL_ESH_CO_SEARCH_LOGGING has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_ESH_SE_SEARCH_REQUEST 20081013 Search Request
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_EXEC_MODE_COMPARE Constant Public Type reference (TYPE) ESH_E_CO_EXEC_MODE 'C' Execution mode: Compare 20081121
2 GC_EXEC_MODE_DEBUGGING Constant Public Type reference (TYPE) ESH_E_CO_EXEC_MODE 'D' Execution mode: Auth. debugging 20081121
3 GC_EXEC_MODE_PERF_MEASUREMENT Constant Public Type reference (TYPE) ESH_E_CO_EXEC_MODE 'P' Execution mode: Performance mesaurement 20081121
4 GC_EXEC_MODE_REEXECUTION Constant Public Type reference (TYPE) ESH_E_CO_EXEC_MODE 'E' Execution mode: Re-execution 20081121
5 GC_EXEC_MODE_REFERENCE_REQUEST Constant Public Type reference (TYPE) ESH_E_CO_EXEC_MODE 'R' Execution mode: Reference request 20081121
6 MR_REF_REQ_HANDLER Instance attribute Protected Object reference (TYPE REF TO) CL_ESH_CO_REFERENCE_REQUESTS Reference requests handler 20081121
7 MT_BULK_QUERY_SCOPE Instance attribute Protected Type reference (TYPE) ESH_T_IF_SEARCH_CONNECTORS2 Bulk query scope 20081008
8 MT_HASHEDOBJECTS Instance attribute Protected Type reference (TYPE) ESH_T_CO_QLOGQ Hashed objects 20080624
9 MT_LAST_SUBQ_ITEM Instance attribute Protected Type reference (TYPE) LTY_T_LAST_SUBQ_ITEM Last subquery Item 20081120
10 MT_QLOG Instance attribute Protected Type reference (TYPE) ESH_T_CO_QLOG_RT Search request log table 20080623
11 MT_QLOG_BULK_RESPONSES Instance attribute Protected Type reference (TYPE) ESH_T_CO_QLOG_RT Search request log table: Bulk responses 20081120
12 MV_ASYNC Instance attribute Protected Type reference (TYPE) ESH_E_CO_ASYNC_CALL Asynchronous search request 20081120
13 MV_BULK_QUERY Instance attribute Protected Type reference (TYPE) ESH_E_CO_BOOLEAN Bulk query 20081008
14 MV_EXEC_MODE Instance attribute Protected Type reference (TYPE) ESH_E_CO_EXEC_MODE Execution mode 20081120
15 MV_RESUME_COUNTER Instance attribute Protected Type reference (TYPE) I Number of resumes (in asynchronous case) 20081120
16 MV_SEARCH_REQUEST_ID Instance attribute Protected Type reference (TYPE) ESH_E_CO_REQ_ID Search request ID 20080623
17 MV_SUBQUERY_COUNTER Instance attribute Protected Type reference (TYPE) I Internal subquery counter 20080623
18 MV_SUBQUERY_ID Instance attribute Protected Type reference (TYPE) ESH_E_CO_SUBQ_ID Subquery ID 20080624
19 MV_SUBQUERY_PREFIX Instance attribute Protected Type reference (TYPE) CHAR10 Additional subquery prefix 20080919
Methods
# Method Level Visibility Method type Description Created on
1 COMMIT_LOG_TO_DB Instance method Public Method Save request log 20080624
2 CONSTRUCTOR Instance method Public Constructor 20080623
3 EXTERNAL_QUERY_GET_HASHKEY Instance method Public Method Get hashkey for the external query 20080623
4 EXTERNAL_QUERY_SET_HASHKEY Instance method Public Method Set hashkey for the external query 20081009
5 GET_NEXT_SUBQUERY_ID Instance method Protected Method Get next subquery ID 20080623
6 GET_NEXT_SUBQUERY_ITEM_ID Instance method Protected Method Get next subquery Item ID 20081120
7 GET_SEARCH_REQUEST_ID Instance method Protected Method Get search request ID 20080623
8 INTERNAL_QUERY_GET_HASHKEY Instance method Public Method Get hashkey for the internal query 20080623
9 INTERNAL_QUERY_SET_HASHKEY Instance method Public Method Set hashkey for the internal query 20081009
10 LOG_BULK_QUERY_EXECUTION Instance method Public Method Add new log record - bulk query 20081008
11 LOG_BULK_RESPONSE Instance method Public Method Add response/exception attributes to log for bulk query 20081008
12 LOG_BULK_RESPONSE_DETAILS Instance method Private Method Log bulk response details 20081120
13 LOG_EXCEPTION Instance method Public Method Log exception occurring during search 20080625
14 LOG_GLOBAL_REQUEST_PROPERTIES Instance method Public Method Log global request properties 20081120
15 LOG_KERNEL_RUNTIME Instance method Public Method Log kernel runtime 20080624
16 LOG_QUERY_EXECUTION Instance method Public Method Add new log record 20080624
17 LOG_RESPONSE Instance method Public Method Add response/exception attributes to log 20080624
18 QUERY_START_TIMER Instance method Public Method Start timer - query (gross) 20080624
19 QUERY_STOP_TIMER Instance method Public Method Stop Timer - query (gross) 20080624
20 REFERENCE_REQUEST_GET_HASHKEY Instance method Private Method Get hashkey for reference request (enhashing full response) 20081121
21 REFERENCE_REQUEST_SET_HASHKEY Instance method Private Method Set hashkey for reference request 20081121
22 RESET_WHOLE_CONTEXT Instance method Public Method Reset entire context 20081008
23 RESUME Instance method Public Method Resume logging 20081120
24 TREX_START_TIMER Instance method Public Method Start timer - TREX call (gross) 20080624
25 TREX_STOP_TIMER Instance method Public Method Stop timer - TREX call (gross) 20080624
Events
Class CL_ESH_CO_SEARCH_LOGGING has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 LTY_S_LAST_SUBQ_ITEM Protected See coding 20081120 BEGIN OF lty_s_last_subq_item, subq_id TYPE esh_e_co_subq_id, subq_item_counter TYPE int4, END OF lty_s_last_subq_item
2 LTY_S_QUERY_INPUT Public See coding 20081121 BEGIN OF lty_s_query_input, counter TYPE i, iv_search_text TYPE string, iv_search_terms TYPE string, is_attr_select_options TYPE esh_s_if_attr_select_options, it_internal_query TYPE trext_query_entries, END OF lty_s_query_input
3 LTY_T_LAST_SUBQ_ITEM Protected See coding 20081120 lty_t_last_subq_item TYPE STANDARD TABLE OF lty_s_last_subq_item
4 LTY_T_QUERY_INPUT Public See coding 20081121 lty_t_query_input TYPE STANDARD TABLE OF lty_s_query_input WITH NON-UNIQUE KEY counter
Method Signatures

Method COMMIT_LOG_TO_DB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_QLOG Call by reference Type reference (TYPE) ESH_T_CO_QLOG Search Request Log 20080624
2 Importing IT_QLOG_RT Call by reference Type reference (TYPE) ESH_T_CO_QLOG_RT Search Request Log with RT Counters 20080624
3 Importing IV_DO_COMMIT Call by reference Type reference (TYPE) ESH_E_CO_BOOLEAN 'X': Commit Work 20080624

Method COMMIT_LOG_TO_DB on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SEARCH_REQUEST_ID Call by reference Type reference (TYPE) CHAR32 Optional: Unique Search Request ID 20080919
2 Importing IV_SUBQUERY_PREFIX Call by reference Type reference (TYPE) CHAR10 Optional: Additional Subquery Prefix 20080919

Method CONSTRUCTOR on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method EXTERNAL_QUERY_GET_HASHKEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_HASHKEY Call by reference Type reference (TYPE) ESH_E_CO_QUERY_EXT_HKY Query Hashkey - External Format 20080623
2 Importing IT_ATTR_SELECT_OPTIONS Call by reference Type reference (TYPE) ESH_T_IF_ATTR_SELECT_OPTIONS Table type for attribute and select options 20080623
3 Importing IT_INTERNAL_QUERY Call by reference Type reference (TYPE) TREXT_QUERY_ENTRIES Search query 20080623
4 Importing IT_QUERY_INPUT Call by reference Type reference (TYPE) LTY_T_QUERY_INPUT Query Input as passed via Set Methods 20081121
5 Importing IV_SEARCH_TERMS Call by reference Type reference (TYPE) STRING Search Terms 20080623
6 Importing IV_SEARCH_TEXT Call by reference Type reference (TYPE) STRING Search Text 20080623

Method EXTERNAL_QUERY_GET_HASHKEY on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method EXTERNAL_QUERY_SET_HASHKEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_HASHKEY Call by reference Type reference (TYPE) ESH_E_CO_QUERY_EXT_HKY Query Hashkey - External Format 20081009

Method EXTERNAL_QUERY_SET_HASHKEY on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method GET_NEXT_SUBQUERY_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EV_SUBQ_ID Value transfer Type reference (TYPE) ESH_E_CO_SUBQ_ID Subquery ID 20080624

Method GET_NEXT_SUBQUERY_ID on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method GET_NEXT_SUBQUERY_ITEM_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EV_SUBQ_ITEM_ID Value transfer Type reference (TYPE) ESH_E_CO_SUBQ_ID Subquery Item ID 20081120
2 Importing IV_SUBQ_ID Call by reference Type reference (TYPE) ESH_E_CO_SUBQ_ID Subquery ID (Header Record) 20081120

Method GET_NEXT_SUBQUERY_ITEM_ID on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method GET_SEARCH_REQUEST_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EV_SEARCH_REQUEST_ID Value transfer Type reference (TYPE) ESH_E_CO_REQ_ID Search Request ID 20080623

Method GET_SEARCH_REQUEST_ID on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method INTERNAL_QUERY_GET_HASHKEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_HASHKEY Call by reference Type reference (TYPE) ESH_E_CO_QUERY_HKY Query Hashkey - Internal Format 20080630
2 Importing IS_ATTR_DIST_GLOBAL Call by reference Type reference (TYPE) TREXS_ATTR_DIST_GLOBAL Attribute distribution: Global settings 20080630
3 Importing IT_BULK_SEARCH_REQUESTS Call by reference Type reference (TYPE) TREXT_SEARCH_REQUESTS Search Requests 20081009
4 Importing IT_COMP_DESCR Call by reference Type reference (TYPE) TREXT_COMP_DESCR Description of the components 20080630
5 Importing IT_CONSTRAINTS Call by reference Type reference (TYPE) TREXT_PLACEHOLDERS Placeholder 20080630
6 Importing IT_HINTS Call by reference Type reference (TYPE) TREXT_HINTS Hints for the optimizer 20080630
7 Importing IT_INDEXES Call by reference Type reference (TYPE) TREXT_INDEXLIST Indexes with language and rfc destination 20080630
8 Importing IT_NAVIGATION_ATTR Call by reference Type reference (TYPE) TREXT_ATTRIBUTES Attributes 20080630
9 Importing IT_QUERY_INTERNAL Call by reference Type reference (TYPE) TREXT_QUERY_ENTRIES Search query 20080630
10 Importing IT_REQUESTED_ATTR Call by reference Type reference (TYPE) TREXT_JOIN_ATTRIBUTES Attributes with indexId and join path 20080630
11 Importing IT_REQUESTED_LANG Call by reference Type reference (TYPE) TREXT_LANGUAGES Languages (ISO 639) 20080630
12 Importing IT_SORT_ATTRIBUTES Call by reference Type reference (TYPE) TREXT_SORT_ATTRIBUTES Sort attributes 20080630
13 Importing IV_BEST_NAV_ATTR Call by reference Type reference (TYPE) I 20080630
14 Importing IV_COUNT_ONLY Call by reference Type reference (TYPE) CHAR01 Character Field Length 1 20080630
15 Importing IV_REQUESTED_FLAG Call by reference Type reference (TYPE) TREX_RFC-REQUEST_FLAG 20080630
16 Importing IV_REQUESTED_RESULTS Call by reference Type reference (TYPE) TREX_RFC-REQUESTED_RESULTS 1: documents 2: statistical info 3: statistical overview 20080630
17 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20080630
18 Importing IV_TREX_API Call by reference Type reference (TYPE) FUNCNAME TREX API Name 20081009

Method INTERNAL_QUERY_GET_HASHKEY on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method INTERNAL_QUERY_SET_HASHKEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_HASHKEY Call by reference Type reference (TYPE) ESH_E_CO_QUERY_EXT_HKY Query Hashkey - External Format 20081009

Method INTERNAL_QUERY_SET_HASHKEY on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method LOG_BULK_QUERY_EXECUTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_BULK_QUERY_SCOPE Call by reference Type reference (TYPE) ESH_T_IF_SEARCH_CONNECTORS2 Search Connectors 20081008

Method LOG_BULK_QUERY_EXECUTION on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method LOG_BULK_RESPONSE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_BULK_RESPONSE Call by reference Type reference (TYPE) ESH_T_SE_TREX_SEARCH_SCOPE 20081008

Method LOG_BULK_RESPONSE on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method LOG_BULK_RESPONSE_DETAILS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_QLOG Call by reference Type reference (TYPE) ESH_S_CO_QLOG_RT QLog Entry 20081120
2 Importing IT_BULK_RESPONSE Call by reference Type reference (TYPE) ESH_T_SE_TREX_SEARCH_SCOPE Search Scope (as passed to TREX Interface) 20081120
3 Importing IV_REQUEST Call by reference Type reference (TYPE) ESH_E_IF_REQUEST_TYPE_ID Request Type ID 20081120
4 Importing IV_SEARCH_CONNECTOR_ID Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_CONNECTOR_ID Search Connector ID 20081120

Method LOG_BULK_RESPONSE_DETAILS on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method LOG_EXCEPTION 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) STRING Exception Message 20080625
2 Importing IV_TREX_RC Call by reference Type reference (TYPE) TREX_RFC-RETURN_CODE TREX Exception ID 20080625

Method LOG_EXCEPTION on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method LOG_GLOBAL_REQUEST_PROPERTIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_REF_REQ_HANDLER Call by reference Object reference (TYPE REF TO) CL_ESH_CO_REFERENCE_REQUESTS Reference Requests Handler 20081121
2 Importing IV_ASYNC Call by reference Type reference (TYPE) ESH_E_CO_ASYNC_CALL Asynchronous Search Request 20081120
3 Importing IV_END_INDEX Call by reference Type reference (TYPE) ESH_E_CO_END_IDX Search End Index 20081120
4 Importing IV_EXEC_MODE Call by reference Type reference (TYPE) ESH_E_CO_EXEC_MODE Execution Mode 20081120
5 Importing IV_SEARCH_DATE Call by reference Type reference (TYPE) ESH_E_CO_SEARCH_DATE Search Date (Date Dependent Search) 20081120
6 Importing IV_START_INDEX Call by reference Type reference (TYPE) ESH_E_CO_START_IDX Search Start Index 20081120
7 Importing IV_TERM_ACTION Call by reference Type reference (TYPE) ESH_E_CO_TERM_ACTION Term Action (Search Mode, e.g. denoting Fuzzy Search) 20081120

Method LOG_GLOBAL_REQUEST_PROPERTIES on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method LOG_KERNEL_RUNTIME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_KERNEL_RUNTIME Call by reference Type reference (TYPE) INT4 Kernel Runtime 20080624

Method LOG_KERNEL_RUNTIME on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method LOG_QUERY_EXECUTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CONNID Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_CONNECTOR_ID Search Connector ID 20080624
2 Importing IV_REQUEST Call by reference Type reference (TYPE) ESH_E_IF_REQUEST_TYPE_ID Request Type ID 20080624

Method LOG_QUERY_EXECUTION on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method LOG_RESPONSE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_RESULTS Call by reference Object reference (TYPE REF TO) DATA Reference: Results 20081121
2 Importing IV_HITS Call by reference Type reference (TYPE) INT4 Natural number 20080624
3 Importing IV_HITS_ALL Call by reference Type reference (TYPE) INT4 Natural number 20080624

Method LOG_RESPONSE on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method QUERY_START_TIMER Signature

Method QUERY_START_TIMER on class CL_ESH_CO_SEARCH_LOGGING has no parameter.
Method QUERY_START_TIMER on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method QUERY_STOP_TIMER Signature

Method QUERY_STOP_TIMER on class CL_ESH_CO_SEARCH_LOGGING has no parameter.
Method QUERY_STOP_TIMER on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method REFERENCE_REQUEST_GET_HASHKEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_HASHKEY Call by reference Type reference (TYPE) ESH_E_CO_QUERY_EXT_HKY Query Hashkey - External Format 20081121
2 Importing IV_RESULT Call by reference Object reference (TYPE REF TO) DATA 20081121

Method REFERENCE_REQUEST_GET_HASHKEY on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method REFERENCE_REQUEST_SET_HASHKEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_QLOG Call by reference Type reference (TYPE) ESH_S_CO_QLOG_RT Search Request Log with RT Counters 20081121
2 Importing IV_HASHKEY Call by reference Type reference (TYPE) ESH_E_CO_QUERY_EXT_HKY Reference Response HashKey 20081121

Method REFERENCE_REQUEST_SET_HASHKEY on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method RESET_WHOLE_CONTEXT Signature

Method RESET_WHOLE_CONTEXT on class CL_ESH_CO_SEARCH_LOGGING has no parameter.
Method RESET_WHOLE_CONTEXT on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method RESUME Signature

Method RESUME on class CL_ESH_CO_SEARCH_LOGGING has no parameter.
Method RESUME on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method TREX_START_TIMER Signature

Method TREX_START_TIMER on class CL_ESH_CO_SEARCH_LOGGING has no parameter.
Method TREX_START_TIMER on class CL_ESH_CO_SEARCH_LOGGING has no exception.

Method TREX_STOP_TIMER Signature

Method TREX_STOP_TIMER on class CL_ESH_CO_SEARCH_LOGGING has no parameter.
Method TREX_STOP_TIMER on class CL_ESH_CO_SEARCH_LOGGING has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 712