SAP ABAP Class CL_ESH_FED_RESULT_ASSEMBLER (Result Assembler)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_FEDERATION (Package) Federation
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_ENG_FEDERATION (Package) FederationProperties
| Class | CL_ESH_FED_RESULT_ASSEMBLER | |
| Short Description | Result Assembler | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_FEDERATION | Federation |
| Created | 20081008 | SAP |
| Last change | 20141121 | |
| 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_FED_RESULT_ASSEMBLER has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_ESH_FED_RESPONSE_ENRICHER | 20100914 | Response Enricher |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MT_SCOPE_HIERARCHY |
Instance attribute | Private | Type reference (TYPE) | ESH_T_FED_SCOPE_HIERARCHY | Scope hierarchy with hit distribution | 20081013 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_ATTRIBUTE_DISTRIBUTION |
Instance method | Public | Method | Build distribution hierarchy | 20081105 |
| 2 | ADD_NAVIGATION_INFOS |
Instance method | Private | Method | depricated | 20130802 |
| 3 | ADD_NO_OF_HITS_TO_PARENT |
Instance method | Private | Method | Add the number of hits to the parent category | 20081015 |
| 4 | ADD_RELATED_REQUESTS |
Instance method | Public | Method | Calculate and add the related requests to the responses | 20081218 |
| 5 | ADD_SCOPE_DISTRIBUTION |
Instance method | Public | Method | Build distribution hierarchy | 20081105 |
| 6 | BUILD_RETRIEVE_REQUEST |
Instance method | Private | Method | Build the retrieve request | 20100224 |
Events
Class CL_ESH_FED_RESULT_ASSEMBLER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | LTY_S_HIT_ASSIGN | Private | See coding | 20100423 | BEGIN OF lty_s_hit_assign,
parent TYPE esh_e_if_category_id,
connector TYPE esh_e_if_search_connector_id,
request TYPE esh_e_if_request_type_id,
no_of_hits TYPE i,
END OF lty_s_hit_assign
|
||
| 2 | LTY_S_ICON_BUFFER | Private | See coding | 20081204 | BEGIN OF lty_s_icon_buffer,
connector_id TYPE esh_e_if_search_connector_id,
icon TYPE esh_e_if_web_icon,
END OF lty_s_icon_buffer
|
||
| 3 | LTY_S_NAVIGATION_BUFFER | Private | See coding | 20081013 | BEGIN OF lty_s_navigation_buffer,
connector_id TYPE esh_e_if_search_connector_id,
navigation_info TYPE esh_t_fed_navigation_info,
END OF lty_s_navigation_buffer
|
||
| 4 | LTY_T_HIT_ASSIGN | Private | See coding | 20100423 | lty_t_hit_assign TYPE SORTED TABLE OF lty_s_hit_assign WITH UNIQUE KEY parent connector request
|
||
| 5 | LTY_T_ICON_BUFFER | Private | See coding | 20081204 | lty_t_icon_buffer TYPE SORTED TABLE OF lty_s_icon_buffer WITH UNIQUE KEY connector_id
|
||
| 6 | LTY_T_NAVIGATION_BUFFER | Private | See coding | 20081013 | lty_t_navigation_buffer TYPE SORTED TABLE OF lty_s_navigation_buffer WITH UNIQUE KEY connector_id
|
Method Signatures
Method ADD_ATTRIBUTE_DISTRIBUTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IR_RESPONSES | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESPONSES | Search Responses | 20081105 | ||
| 2 | Importing |
IV_IN_MAX_VALUES | Call by reference | Type reference (TYPE) | INT4 | Natural number | 20110120 | ||
| 3 | Importing |
IV_MAP_COMMON_ATTRIBUTES | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Map Common Attributes | 20100104 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ESH_IF_ENGINE |
ESH Interface Exception | 20100104 |
Method ADD_NAVIGATION_INFOS Signature
Method ADD_NAVIGATION_INFOS on class CL_ESH_FED_RESULT_ASSEMBLER has no parameter.
Method ADD_NAVIGATION_INFOS on class CL_ESH_FED_RESULT_ASSEMBLER has no exception.
Method ADD_NO_OF_HITS_TO_PARENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CT_HIT_ASSIGNMENT | Call by reference | Type reference (TYPE) | LTY_T_HIT_ASSIGN | 20100423 | |||
| 2 | Importing |
IS_CURRENT_NODE | Call by reference | Type reference (TYPE) | ESH_S_FED_SCOPE_HIERARCHY | Scope Hierarchy with Hit Distribution | 20081015 | ||
| 3 | Importing |
IT_HIERARCHY | Call by reference | Type reference (TYPE) | ESH_T_FED_SCOPE_HIERARCHY | Scope Hierarchy with Hit Distribution | 20100423 | ||
| 4 | Importing |
IV_ASYNC_SEARCH | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20081209 | ||
| 5 | Importing |
IV_CONNNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20100423 | ||
| 6 | Importing |
IV_NO_OF_HITS | Call by reference | Type reference (TYPE) | INT4 | Natural number | 20090909 | ||
| 7 | Importing |
IV_REQUEST_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_REQUEST_TYPE_ID | Request Type ID | 20100423 |
Method ADD_NO_OF_HITS_TO_PARENT on class CL_ESH_FED_RESULT_ASSEMBLER has no exception.
Method ADD_RELATED_REQUESTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_RESPONSES | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESPONSES | Search Responses | 20081218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_FED_RESULT_ASSEMBLY |
Result Assembly Exception | 20090108 | |
| 2 | CX_ESH_IF_ENGINE |
ESH Interface Exception | 20090126 |
Method ADD_SCOPE_DISTRIBUTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
CT_SCOPE_HIERARCHY | Call by reference | Type reference (TYPE) | ESH_T_FED_SCOPE_HIERARCHY | Scope Hierarchy | 20081105 | ||
| 2 | Importing |
IR_RESPONSES | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESPONSES | Search Responses | 20081105 | ||
| 3 | Importing |
IV_ASYNC_SEARCH | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20081209 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_FED_RESULT_ASSEMBLY |
Result Assembly Exception | 20090108 |
Method BUILD_RETRIEVE_REQUEST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ES_REQUEST | Call by reference | Type reference (TYPE) | ESH_S_IF_REL_REQUEST | Related Search Connector Request Internal | 20100224 | ||
| 2 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20100224 | ||
| 3 | Importing |
IV_REQUEST_ATTRIBUTE | Call by reference | Type reference (TYPE) | ESH_E_IF_ATTRIBUTE_NAME | Attribute ID | 20100224 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_ENGINE |
ESH Interface Exception | 20100224 |
History
| Last changed by/on | SAP | 20141121 |
| SAP Release Created in | 720 |
