SAP ABAP Class CL_ESH_TREX_SEARCH_UTILS (Tools, Utilities, and Helper for ESH Searches)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_SEARCH (Package) Search (internal)
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_ENG_SEARCH (Package) Search (internal)Properties
| Class | CL_ESH_TREX_SEARCH_UTILS | |
| Short Description | Tools, Utilities, and Helper for ESH Searches | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_SEARCH | Search (internal) |
| Created | 20100624 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  CL_ESH_TREX_PROXY_RUNTIME |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_ESH_TREX_SEARCH_UTILS has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_ESH_TREX_SEARCH | 20100629 | Execute an ESH Search on TREX |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MR_ME |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_ESH_TREX_SEARCH_UTILS | Tools, utilities, and helper for ESH searches | 20100629 | ||
| 2 | MR_RUNTIME_BUFFER |
Static Attribute | Private | Object reference (TYPE REF TO) | IF_ESH_SE_RUNTIME_DATA | Runtime buffer | 20100630 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | COMPILE_TREX_QUERY_BY_REQUEST |
Instance method | Private | Method | Compile Query by Request | 20100802 |
| 2 | GET_INSTANCE |
Static method | Public | Method | Get Instance | 20100629 |
| 3 | GET_QUERY |
Instance method | Private | Method | Get Query | 20100802 |
| 4 | GET_REQUESTED_LANGUAGES |
Instance method | Private | Method | Get requested languages | 20100630 |
Events
Class CL_ESH_TREX_SEARCH_UTILS has no event.
Types
Class CL_ESH_TREX_SEARCH_UTILS has no local type.
Method Signatures
Method COMPILE_TREX_QUERY_BY_REQUEST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ER_RESULT_TABLE | Call by reference | Object reference (TYPE REF TO) | DATA | Result Table | 20100802 | ||
| 2 | Exporting |
ER_RESULT_TABLE_SEC | Call by reference | Object reference (TYPE REF TO) | DATA | Result Table | 20101005 | ||
| 3 | Exporting |
ES_ATTR_DIST_GLOBAL | Call by reference | Type reference (TYPE) | TREXS_ATTR_DIST_GLOBAL | Attribute Distribution Global | 20100802 | ||
| 4 | Exporting |
ET_ATTRIBUTE_LIST | Call by reference | Type reference (TYPE) | ESH_T_JOIN_ATTRIBUTES_LIST | Attribute List | 20100806 | ||
| 5 | Exporting |
ET_ATTR_DIST_DEFINITION | Call by reference | Type reference (TYPE) | TREXT_ATTR_DIST_DEFINITION | Attribute Distribution Definition | 20101005 | ||
| 6 | Exporting |
ET_COMP_DESCR | Call by reference | Type reference (TYPE) | TREXT_COMP_DESCR | Component Description | 20100802 | ||
| 7 | Exporting |
ET_FS_SEARCH_ATTRIBUTES | Call by reference | Type reference (TYPE) | TREXT_ATTRIBUTES | Freestyle Search Attributes | 20100802 | ||
| 8 | Exporting |
ET_FS_SEARCH_ATTRIBUTES2 | Call by reference | Type reference (TYPE) | TREXT_FREESTYLE_ATTRIBUTES | Freestyle Search Attributes wit Rank | 20100802 | ||
| 9 | Exporting |
ET_GNAV_ATTRIBUTES | Call by reference | Type reference (TYPE) | TREXT_ATTRIBUTES | Guided-Navigation Attributes | 20100802 | ||
| 10 | Exporting |
ET_HINTS | Call by reference | Type reference (TYPE) | TREXT_HINTS | Hints | 20100802 | ||
| 11 | Exporting |
ET_INDEXES | Call by reference | Type reference (TYPE) | TREXT_INDEXLIST | Indexes | 20100802 | ||
| 12 | Exporting |
ET_KEY_FIGURES | Call by reference | Type reference (TYPE) | TREXT_KEY_FIGURE | Key Figures | 20100802 | ||
| 13 | Exporting |
ET_PLACEHOLDERS | Call by reference | Type reference (TYPE) | TREXT_PLACEHOLDERS | Constraint Placeholders | 20100802 | ||
| 14 | Exporting |
ET_QUERY_ENTRIES | Call by reference | Type reference (TYPE) | HDBT_QUERY_ENTRIES | Query Entries for HANA | 20100802 | ||
| 15 | Exporting |
ET_QUERY_ENTRIES_OLD | Call by reference | Type reference (TYPE) | TREXT_QUERY_ENTRIES | Search query | 20131205 | ||
| 16 | Exporting |
ET_REQUESTED_LANGUAGES | Call by reference | Type reference (TYPE) | TREXT_LANGUAGES | Requested Languages | 20100802 | ||
| 17 | Exporting |
ET_REQ_ATTRIBUTES | Call by reference | Type reference (TYPE) | TREXT_JOIN_ATTRIBUTES | Requestetd Attributes | 20100802 | ||
| 18 | Exporting |
ET_RESPONSE_ATTRIBUTE_TYPES | Call by reference | Type reference (TYPE) | IF_ESH_SE_RUNTIME_DATA=>S_SEARCH_EXEC_SORTED-RESPONSE_ATTRIBUTE_TYPES | Response Attribute Types | 20100806 | ||
| 19 | Exporting |
ET_SORT_ATTRIBUTES | Call by reference | Type reference (TYPE) | TREXT_SORT_ATTRIBUTES | Sort Attributes | 20100802 | ||
| 20 | Exporting |
EV_COUNT_ONLY | Call by reference | Type reference (TYPE) | CHAR1 | Count-Only | 20100802 | ||
| 21 | Exporting |
EV_HAVING_FILTER | Call by reference | Type reference (TYPE) | STRING | Having Filter | 20100802 | ||
| 22 | Exporting |
EV_NO_SEARCH_NECESSARY | Call by reference | Type reference (TYPE) | ABAP_BOOL | No search necessary due to lack of authorization | 20131115 | ||
| 23 | Exporting |
EV_NUM_BEST_GNAV_ATTRIBUTES | Call by reference | Type reference (TYPE) | INT4 | Number of Best GNav Attributes | 20100802 | ||
| 24 | Exporting |
EV_REQUESTED_RESULTS | Call by reference | Type reference (TYPE) | INT1 | Requested Results | 20100802 | ||
| 25 | Exporting |
EV_REQUEST_FLAGS | Call by reference | Type reference (TYPE) | NUMC10 | Request Flags | 20100802 | ||
| 26 | Exporting |
EV_RESULT_FROM | Call by reference | Type reference (TYPE) | INT4 | From | 20100802 | ||
| 27 | Exporting |
EV_RESULT_INDEX_NAME | Call by reference | Type reference (TYPE) | TREXD_INDEX_ID | Result Index Name | 20100802 | ||
| 28 | Exporting |
EV_RESULT_TO | Call by reference | Type reference (TYPE) | INT4 | To | 20100802 | ||
| 29 | Exporting |
EV_SEARCH_LANGUAGE | Call by reference | Type reference (TYPE) | LAISO | Language according to ISO 639 | 20130819 | ||
| 30 | Exporting |
EV_SWITCH_ON_TRACE | Call by reference | Type reference (TYPE) | NUMC2 | Switch on Trace | 20100802 | ||
| 31 | Exporting |
EV_TIMEOUT | Call by reference | Type reference (TYPE) | INT4 | Timeout | 20101005 | ||
| 32 | Exporting |
EV_TRACE_COMPONENTS | Call by reference | Type reference (TYPE) | CHAR128 | Trace Components | 20100802 | ||
| 33 |  Importing |
IR_PROXY | Call by reference | Object reference (TYPE REF TO) | CL_ESH_TREX_PROXY_RUNTIME | Search Proxy | 20130823 | ||
| 34 | Importing |
IR_QUERY_HANDLER | Call by reference | Object reference (TYPE REF TO) | CL_ESH_TREX_QUERY_HANDLER | Query Handler | 20100802 | ||
| 35 | Importing |
IR_REQUEST_DATA | Call by reference | Object reference (TYPE REF TO) | CL_ESH_FED_REQUEST_DATA | Request Data | 20100802 | ||
| 36 | Importing |
IS_FED_SEARCH_DOMAIN | Call by reference | Type reference (TYPE) | ESH_S_FED_SCOPE | Search Domain (Scope) | 20100802 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ESH_IF_ENGINE |
20100803 |
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_QUERY_HANDLER | Call by reference | Object reference (TYPE REF TO) | CL_ESH_TREX_QUERY_HANDLER | 20100802 | |||
| 2 |  Returning |
RR_INSTANCE | Value transfer | Object reference (TYPE REF TO) | CL_ESH_TREX_SEARCH_UTILS | Tools, utilities and helper for ESH searches | 20100629 |
Method GET_INSTANCE on class CL_ESH_TREX_SEARCH_UTILS has no exception.
Method GET_QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CT_TREX_AUTH_QUERY | Call by reference | Type reference (TYPE) | HDBT_QUERY_ENTRIES | Query | 20100802 | ||
| 2 | Changing |
CT_TREX_CONSTRAINTS | Call by reference | Type reference (TYPE) | TREXT_PLACEHOLDERS | Query Constraints | 20100802 | ||
| 3 | Changing |
CT_TREX_HINTS | Call by reference | Type reference (TYPE) | TREXT_HINTS | Query Hints | 20100802 | ||
| 4 | Exporting |
EV_NO_SEARCH_NECESSARY | Call by reference | Type reference (TYPE) | ABAP_BOOL | No search necessary due to lack of authorization | 20131115 | ||
| 5 | Importing |
IR_PROXY | Call by reference | Object reference (TYPE REF TO) | CL_ESH_TREX_PROXY_RUNTIME | Search Proxy | 20130823 | ||
| 6 | Importing |
IR_QUERY_HANDLER | Call by reference | Object reference (TYPE REF TO) | CL_ESH_TREX_QUERY_HANDLER | Query Handler | 20100802 | ||
| 7 | Importing |
IR_REQUEST_DATA | Call by reference | Object reference (TYPE REF TO) | CL_ESH_FED_REQUEST_DATA | Search Request Data | 20100802 | ||
| 8 | Importing |
IS_CONNECTOR_EXECUTION | Call by reference | Type reference (TYPE) | IF_ESH_SE_RUNTIME_DATA=>S_SEARCH_EXEC_SORTED | Connector Execution Metadata | 20100802 | ||
| 9 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Connector ID | 20100802 | ||
| 10 | Importing |
IV_REQUEST_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_REQUEST | Request | 20100802 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_ENGINE |
20100802 |
Method GET_REQUESTED_LANGUAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RT_REQUESTED_LANG | Value transfer | Type reference (TYPE) | TREXT_LANGUAGES | Languages (ISO 639) | 20100630 |
Method GET_REQUESTED_LANGUAGES on class CL_ESH_TREX_SEARCH_UTILS has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 703 |
