SAP ABAP Class CL_ESH_IF_SEARCH_OBJECTS (Search Objects)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_INTERFACE (Package) Interface
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_ENG_INTERFACE (Package) InterfaceProperties
| Class | CL_ESH_IF_SEARCH_OBJECTS | |
| Short Description | Search Objects | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_INTERFACE | Interface |
| Created | 20070405 | SAP |
| Last change | 20130531 | 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_OBJECTS has no interface implemented.
Friends
Class CL_ESH_IF_SEARCH_OBJECTS has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GT_REQUESTS |
Instance attribute | Private | Type reference (TYPE) | ESH_T_IF_SEARCH_REQUESTS | Search requests | 20070405 | ||
| 2 | GT_RESPONSES |
Instance attribute | Private | Type reference (TYPE) | ESH_T_IF_SEARCH_RESPONSES | Search responses | 20070405 | ||
| 3 | GV_RECEIVED_TASKS |
Instance attribute | Private | Type reference (TYPE) | I | Number of received tasks | 20070405 | ||
| 4 | GV_STARTED_TASKS |
Instance attribute | Private | Type reference (TYPE) | I | Number of started tasks | 20070405 | ||
| 5 | GV_TREX_DEST |
Instance attribute | Private | Type reference (TYPE) | RFCDEST | Logical destination (specified in function call) | 20070405 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CONSTRUCTOR |
Instance method | Public | Constructor | Constructor | 20070405 |
| 2 | PROCESS_RESULTS |
Instance method | Private | Method | Process search results | 20070521 |
| 3 | RECEIVE_RESULTS |
Instance method | Public | Method | Receive results from parallel tasks | 20070405 |
| 4 | SEARCH |
Instance method | Public | Method | Search | 20070405 |
Events
Class CL_ESH_IF_SEARCH_OBJECTS has no event.
Types
Class CL_ESH_IF_SEARCH_OBJECTS has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IT_REQUESTS | Call by reference | Type reference (TYPE) | ESH_T_IF_SEARCH_REQUESTS | Search requests | 20070405 |
Method CONSTRUCTOR on class CL_ESH_IF_SEARCH_OBJECTS has no exception.
Method PROCESS_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_RUNTIME | Call by reference | Type reference (TYPE) | TREXS_COMPONENT_RUNTIME | run time of the trex components | 20070521 | ||
| 2 | Importing |
IT_ATTR_DIST_RANGES | Call by reference | Type reference (TYPE) | TREXT_ATTR_DIST_RANGES | Attribute distribution ranges | 20070521 | ||
| 3 | Importing |
IT_ATTR_DIST_VALUES | Call by reference | Type reference (TYPE) | TREXT_ATTR_DIST_VALUES | Attribute distribution values | 20070521 | ||
| 4 | Importing |
IT_FIELDS | Call by reference | Type reference (TYPE) | DDFIELDS | DD: Field List | 20070521 | ||
| 5 | Importing |
IT_KEY_ATTR | Call by reference | Type reference (TYPE) | TREXT_JOIN_ATTRIBUTES | Attributes with indexId and join path | 20070521 | ||
| 6 | Importing |
IT_REQ_ATTR | Call by reference | Type reference (TYPE) | TREXT_JOIN_ATTRIBUTES | Attributes with indexId and join path | 20070521 | ||
| 7 | Importing |
IT_STRING_RESULT | Call by reference | Type reference (TYPE) | ESH_T_STRING | Table of strings | 20070521 | ||
| 8 | Importing |
IV_HITS | Call by reference | Type reference (TYPE) | I | 20070521 | |||
| 9 | Importing |
IV_REQUEST_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_REQUEST_ID | Request ID | 20070521 | ||
| 10 | Importing |
IV_RETURN_CODE | Call by reference | Type reference (TYPE) | TREX_RFC-RETURN_CODE | Return Code | 20070521 | ||
| 11 | Importing |
IV_RETURN_TEXT | Call by reference | Type reference (TYPE) | TREX_RFC-RETURN_TEXT | Return Text | 20070521 | ||
| 12 | Importing |
IV_START_TIME | Call by reference | Type reference (TYPE) | I | 20070521 |
Method PROCESS_RESULTS on class CL_ESH_IF_SEARCH_OBJECTS has no exception.
Method RECEIVE_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
P_TASK | Call by reference | Type reference (TYPE) | CLIKE | Task ID | 20070405 |
Method RECEIVE_RESULTS on class CL_ESH_IF_SEARCH_OBJECTS has no exception.
Method SEARCH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_RESPONSES | Call by reference | Type reference (TYPE) | ESH_T_IF_SEARCH_RESPONSES | Search responses | 20070405 | ||
| 2 | Importing |
IV_SYNC_MODE | Call by reference | Type reference (TYPE) | FLAG | 'X' | Synchronous search | 20070521 |
Method SEARCH on class CL_ESH_IF_SEARCH_OBJECTS has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 100 |
