SAP ABAP Class CL_ESH_FED_RESPONSES_BUILDER (Responses Builder)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_FEDERATION (Package) Federation
⤷
⤷
Properties
| Class | CL_ESH_FED_RESPONSES_BUILDER | |
| Short Description | Responses Builder | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_FEDERATION | Federation |
| Created | 20080813 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_ESH_FED_RESPONSES_BUILDER has no forward declaration.
Interfaces
Class CL_ESH_FED_RESPONSES_BUILDER has no interface implemented.
Friends
Class CL_ESH_FED_RESPONSES_BUILDER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESPONSES | 20100726 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Add message | 20090113 | |
| 2 | Instance method | Public | Method | Add a response object | 20080813 | |
| 3 | Instance method | Public | Method | Add the scope distribution tree | 20081015 | |
| 4 | Instance method | Public | Constructor | Constructor | 20080813 | |
| 5 | Instance method | Public | Method | Get the assembled reponses object | 20080813 | |
| 6 | Instance method | Public | Method | Set/replace the connector statistics | 20090114 | |
| 7 | Instance method | Public | Method | Set/overwrite number of results | 20090126 | |
| 8 | Instance method | Public | Method | Set source request | 20100803 |
Events
Class CL_ESH_FED_RESPONSES_BUILDER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | LTY_S_INT_RESULT_LIST | Public | See coding | 20100726 | BEGIN OF lty_s_int_result_list,
connector_id TYPE esh_e_if_search_connector_id,
request_id TYPE esh_e_if_request_id,
result_list_ref TYPE REF TO esh_s_if_grouped_result_data,
END of lty_s_int_result_list
|
||
| 2 | LTY_T_INT_RESULT_LISTS | Public | See coding | 20100726 | lty_t_int_result_lists TYPE HASHED TABLE OF lty_s_int_result_list
WITH UNIQUE KEY connector_id request_id
|
Method Signatures
Method ADD_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_MESSAGE | Call by reference | Type reference (TYPE) | ESH_S_IF_MESSAGE | Message returned by the search runtime | 20090113 |
Method ADD_MESSAGE on class CL_ESH_FED_RESPONSES_BUILDER has no exception.
Method ADD_RESPONSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_RESPONSE | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESPONSE | Search Response | 20080813 |
Method ADD_RESPONSE on class CL_ESH_FED_RESPONSES_BUILDER has no exception.
Method ADD_SCOPE_DISTRIBUTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_SCOPE_HIERARCHY | Call by reference | Type reference (TYPE) | ESH_T_IF_SCOPE_DISTRIBUTION | Distribution of Results | 20081015 |
Method ADD_SCOPE_DISTRIBUTION on class CL_ESH_FED_RESPONSES_BUILDER has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_RESPONSES | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESPONSES | Search Responses | 20080926 |
Method CONSTRUCTOR on class CL_ESH_FED_RESPONSES_BUILDER has no exception.
Method GET_RESPONSES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_RESPONSES | Value transfer | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESPONSES | Search Responses | 20080813 |
Method GET_RESPONSES on class CL_ESH_FED_RESPONSES_BUILDER has no exception.
Method SET_CONNECTOR_STATISTICS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_CONNECTOR_STATISTICS | Call by reference | Type reference (TYPE) | ESH_T_IF_CONNECTOR_STATISTICS | Search Statistics for Connectors | 20090114 |
Method SET_CONNECTOR_STATISTICS on class CL_ESH_FED_RESPONSES_BUILDER has no exception.
Method SET_NUMBER_OF_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_NUMBER_OF_RESULTS | Call by reference | Type reference (TYPE) | INT4 | Natural number | 20090126 | |||
| 2 | IV_NUMBER_OF_TOTAL_RESULTS | Call by reference | Type reference (TYPE) | INT4 | Natural number | 20090126 |
Method SET_NUMBER_OF_RESULTS on class CL_ESH_FED_RESPONSES_BUILDER has no exception.
Method SET_SOURCE_REQUEST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_REQUEST_DATA | Call by reference | Object reference (TYPE REF TO) | CL_ESH_FED_REQUEST_DATA | Search Request Data | 20100803 |
Method SET_SOURCE_REQUEST on class CL_ESH_FED_RESPONSES_BUILDER has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 712 |