SAP ABAP Class IF_ESH_FED_FEDERATION_SEARCH (Federation Search Interface)
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_ESH_ADAPT_BI | BI Adapter | 20081031 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_ESH_ADAPT_COMMON_RUNTIME | CR Adapter | 20080815 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_ESH_ADAPT_FS | File Search Adapter | 20080812 |
| 4 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_ESH_ADAPT_KM | KM Adapter for Searching in KM | 20080811 |
| 5 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_ESH_ADAPT_OPEN_SEARCH | Open Search Adapter | 20080814 |
| 6 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_ESH_ADAPT_SES | SES Adapter for external SES | 20080808 |
| 7 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_ESH_FED_SEARCH_FEDERATER | Search Federator | 20080820 |
| 8 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_ESH_TREX_SEARCH | Execute an ESH Search on TREX | 20091217 |
Properties
| Class | IF_ESH_FED_FEDERATION_SEARCH | |
| Short Description | Federation Search Interface | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20080731 | SAP |
| Last change | 20110908 | 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 IF_ESH_FED_FEDERATION_SEARCH has no interface implemented.
Friends
Class IF_ESH_FED_FEDERATION_SEARCH has no friend class.
Attributes
Class IF_ESH_FED_FEDERATION_SEARCH has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_ASYNC_RESULTS |
Instance method | Public | Method | Returns the current merged or grouped list for an async. Src | 20080930 |
| 2 | HAS_NEW_ASYNC_RESULTS |
Instance method | Public | Method | Checks whether a Search started async. has new results | 20080930 |
| 3 | IS_ASYNC_FINISHED |
Instance method | Public | Method | Asynchronous Search is finished | 20080930 |
| 4 | SEARCH_ASYNC |
Instance method | Public | Method | Execute the Search async. with grouped responses | 20080930 |
| 5 | SEARCH_BULK |
Instance method | Public | Method | Execute Bulk Search (Multiple Queries in one call) | 20091217 |
| 6 | SEARCH_GROUPED |
Instance method | Public | Method | Execute the Search with grouped responses | 20080814 |
| 7 | SEARCH_MERGED |
Instance method | Public | Method | Execute the Search with a merged response | 20080814 |
| 8 | STOP_CURRENT_SEARCH |
Instance method | Public | Method | Stop the search recently started | 20090109 |
Events
Class IF_ESH_FED_FEDERATION_SEARCH has no event.
Types
Class IF_ESH_FED_FEDERATION_SEARCH has no local type.
Method Signatures
Method GET_ASYNC_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_NEW_RESPONSES_ONLY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Return Result Delta | 20090223 | |
| 2 |  Returning |
RR_RESPONSES | Value transfer | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESPONSES | Search Responses | 20080930 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ESH_IF_ENGINE |
ESH Interface Exception | 20090108 |
Method HAS_NEW_ASYNC_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_HAS_NEW_RESULTS | Value transfer | Type reference (TYPE) | BOOLE | Boolean variable | 20080930 |
Method HAS_NEW_ASYNC_RESULTS on class IF_ESH_FED_FEDERATION_SEARCH has no exception.
Method IS_ASYNC_FINISHED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_FINISHED | Value transfer | Type reference (TYPE) | BOOLE | Boolean variable | 20080930 |
Method IS_ASYNC_FINISHED on class IF_ESH_FED_FEDERATION_SEARCH has no exception.
Method SEARCH_ASYNC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_REQUEST_DATA | Call by reference | Object reference (TYPE REF TO) | CL_ESH_FED_REQUEST_DATA | Search Request Data | 20080930 | ||
| 2 | Importing |
IV_MERGE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Merge the results | 20081013 | |
| 3 | Importing |
IV_SORT_BY_RANK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Sort by rank value if no other sort attributes are given | 20091021 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_ENGINE |
ESH Interface Exception | 20090108 |
Method SEARCH_BULK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CT_BULK_CONTAINER | Call by reference | Type reference (TYPE) | ESH_T_FED_BULK_CONTAINER | Request Data Containers for Bulk Search | 20091217 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_ENGINE |
ESH Interface Exception | 20091217 |
Method SEARCH_GROUPED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_REQUEST_DATA | Call by reference | Object reference (TYPE REF TO) | CL_ESH_FED_REQUEST_DATA | Search Request Data | 20080814 | ||
| 2 | Importing |
IV_SORT_BY_RANK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Sort by rank value if no other sort attributes are given | 20091021 | |
| 3 | Returning |
RR_RESPONSES | Value transfer | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESPONSES | Search Responses | 20080814 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_ENGINE |
ESH Interface Exception | 20090108 |
Method SEARCH_MERGED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_REQUEST_DATA | Call by reference | Object reference (TYPE REF TO) | CL_ESH_FED_REQUEST_DATA | Search Request Data | 20080814 | ||
| 2 | Importing |
IV_SORT_BY_RANK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Sort by rank value if no other sort attributes are given | 20090910 | |
| 3 | Returning |
RR_RESPONSES | Value transfer | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESPONSES | Search Responses | 20080814 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_ENGINE |
ESH Interface Exception | 20090108 |
Method STOP_CURRENT_SEARCH Signature
Method STOP_CURRENT_SEARCH on class IF_ESH_FED_FEDERATION_SEARCH has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_ENGINE |
ESH Interface Exception | 20090324 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in |
