SAP ABAP Class CL_ESH_FED_GRP_RESP_BUILDER (Grouped Response 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_GRP_RESP_BUILDER
Short Description	Grouped Response 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	20080812	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 CL_ESH_FED_GRP_RESP_BUILDER has no interface implemented.

Friends

Class CL_ESH_FED_GRP_RESP_BUILDER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_RESPONSE_FIELD_RANK	Constant	Public	☐	Type reference (TYPE)	STRING	'$RANK$'	Reponse field for ranking	20091103
2	GC_RESPONSE_FIELD_WHY_FOUND	Constant	Public	☐	Type reference (TYPE)	STRING	'$WHY_FOUND$'	Reponse field for Why Found	20091103
3	MR_GROUPED_RESPONSE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESP_CONNECT		Search response of connector	20080812
4	MV_CONNECTOR_ID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Connector ID	20081203
5	MV_REQUEST_TYPE_ID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request type ID	20081217

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_RESULT	Instance method	Public	Method	Add a result created in a result builder	20080812
2	CALCULATE_WHY_FOUND	Static method	Private	Method	Calculate Why Found	20091019
3	COMPOSE_CLES_RESPONSE_FIELD	Static method	Private	Method	Compose the response field for classification	20091027
4	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20080812
5	ENTER_ATTRIBUTE_NAMES	Static method	Public	Method	For reworking RAW responses: Fill the attribute name list	20080822
6	FILLUP_EXT_RESULT_TABLE	Static method	Private	Method	Fill the extended result table to the level of the raw table	20081009
7	FILL_ATTRIBUTE_NAMES	Static method	Private	Method	Fill the internal attribute name buffer	20080813
8	GET_RAW_TABLE_FOR_CONNECTOR	Static method	Private	Method	Read connector information	20080812
9	GET_RESPONSE	Instance method	Public	Method	Get the assembled response object	20080813
10	PARSE_WHY_FOUND	Static method	Private	Method	Parse the Why Found string	20091020
11	SET_CONNECTOR_STATISTICS	Instance method	Public	Method	Set connector statistics	20081203
12	SET_DISTRIBUTION_RANGES	Instance method	Public	Method	Set the interactive navigation distribution ranges	20080813
13	SET_DISTRIBUTION_VALUES	Instance method	Public	Method	Set the interactive navigation distribution values	20080813
14	SET_ICON_FOR_ALL_RESULTS	Instance method	Public	Method	Set icon for all results	20081204
15	SET_NUMBER_OF_RESULTS	Instance method	Public	Method	Set number of results of page	20080813
16	SET_RELATED_REQUESTS	Instance method	Public	Method	Set the related requests construction data	20081218
17	SET_SOURCE_REQUEST	Instance method	Public	Method	Set original request	20100823
18	SET_SPONSORED_CONNECTOR_RANK	Static method	Public	Method	Set rank values of sponsored connector	20100219
19	SET_TOTAL_NUMBER_OF_RESULTS	Instance method	Public	Method	Set total number of results	20080813
20	TAKE_OVER_INTERIM_RANK_VALUES	Static method	Private	Method	Fill the internal attribute name buffer	20091012
21	TAKE_OVER_RANK_VALUES	Static method	Private	Method	Take over rank values	20091023

Events

Class CL_ESH_FED_GRP_RESP_BUILDER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LTY_S_ATTRIBUTE	Private	See coding			20091020	BEGIN OF lty_s_attribute, id TYPE esh_e_if_attribute_name, description TYPE string, value TYPE string, END OF lty_s_attribute
2	LTY_S_WHY_FOUND	Private	See coding			20091020	BEGIN OF lty_s_why_found, term TYPE string, attributes TYPE lty_t_attribute, END OF lty_s_why_found
3	LTY_T_ATTRIBUTE	Private	See coding			20091020	lty_t_attribute TYPE SORTED TABLE OF lty_s_attribute WITH UNIQUE KEY id
4	LTY_T_WHY_FOUND	Private	See coding			20091020	lty_t_why_found TYPE SORTED TABLE OF lty_s_why_found WITH UNIQUE KEY term

Method Signatures

Method ADD_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_FED_RESULT_BUILDER		Result Builder	20080812

Method ADD_RESULT on class CL_ESH_FED_GRP_RESP_BUILDER has no exception.

Method CALCULATE_WHY_FOUND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESP_CONNECT		Search Response of Connector	20091019

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20091020

Method COMPOSE_CLES_RESPONSE_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESP_CONNECT		Search Response of Connector	20091027
2	Exporting	EV_SUCCEEDED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20091027

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20091027

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_RESPONSE	Call by reference	☑	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESP_CONNECT		Search Response of Connector	20081204
2	Importing	IV_CONNECTOR_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20080812
3	Importing	IV_REQUEST_TYPE_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request Type ID	20080812

#	Exception	Resumable	Description	Created on
1	CX_ESH_FED_BUILDER_EXCEPTION	☐	Exception at response building	20090121

Method ENTER_ATTRIBUTE_NAMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESP_CONNECT		Search Response of Connector	20080822

#	Exception	Resumable	Description	Created on
1	CX_ESH_FED_BUILDER_EXCEPTION	☐	Exception at response building	20090121

Method FILLUP_EXT_RESULT_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESP_CONNECT		Search Response of Connector	20081009

Method FILLUP_EXT_RESULT_TABLE on class CL_ESH_FED_GRP_RESP_BUILDER has no exception.

Method FILL_ATTRIBUTE_NAMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESP_CONNECT		Search Response of Connector	20081016
2	Importing	IT_ATTR_NAMES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20080813

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20081016

Method GET_RAW_TABLE_FOR_CONNECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_DATA_TABLE_REF	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20080812
2	Exporting	ET_ATTR_NAMES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20080813
3	Importing	IV_SEARCH_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20080812

#	Exception	Resumable	Description	Created on
1	CX_ESH_FED_BUILDER_EXCEPTION	☐	Exception at response building	20090121

Method GET_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_RESPONSE	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESP_CONNECT		Search Response of Connector	20080813

Method GET_RESPONSE on class CL_ESH_FED_GRP_RESP_BUILDER has no exception.

Method PARSE_WHY_FOUND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_WHY_FOUND	Call by reference	☐	Type reference (TYPE)	LTY_T_WHY_FOUND		Why Found Structure	20091020
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20091020
3	Importing	IV_REQUEST_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request Type ID	20091020
4	Importing	IV_WHY_FOUND_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Why Found String	20091020

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20091020

Method SET_CONNECTOR_STATISTICS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONNECTOR_STATISTICS	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_CONNECTOR_STATISTICS		Search Statistic for one Connector	20081203

Method SET_CONNECTOR_STATISTICS on class CL_ESH_FED_GRP_RESP_BUILDER has no exception.

Method SET_DISTRIBUTION_RANGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DISTRIBUTION_RANGES	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_DIST_RANGES		Attribute distribution ranges	20080813

Method SET_DISTRIBUTION_RANGES on class CL_ESH_FED_GRP_RESP_BUILDER has no exception.

Method SET_DISTRIBUTION_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DISTRIBUTION_VALUES	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_DIST_VALUES		Attribute distribution values	20080813

Method SET_DISTRIBUTION_VALUES on class CL_ESH_FED_GRP_RESP_BUILDER has no exception.

Method SET_ICON_FOR_ALL_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ICON	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_WEB_ICON		Icon	20081204

Method SET_ICON_FOR_ALL_RESULTS on class CL_ESH_FED_GRP_RESP_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	Importing	IV_NUMBER	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20080813

Method SET_NUMBER_OF_RESULTS on class CL_ESH_FED_GRP_RESP_BUILDER has no exception.

Method SET_RELATED_REQUESTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RELATED_REQUESTS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_REL_REQUESTS_INT		Related Requests Internal	20081218

Method SET_RELATED_REQUESTS on class CL_ESH_FED_GRP_RESP_BUILDER has no exception.

Method SET_SOURCE_REQUEST 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	20100823

Method SET_SOURCE_REQUEST on class CL_ESH_FED_GRP_RESP_BUILDER has no exception.

Method SET_SPONSORED_CONNECTOR_RANK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESP_CONNECT		Search Response of Connector	20100219

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20100219

Method SET_TOTAL_NUMBER_OF_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NUMBER	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20080813

Method SET_TOTAL_NUMBER_OF_RESULTS on class CL_ESH_FED_GRP_RESP_BUILDER has no exception.

Method TAKE_OVER_INTERIM_RANK_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESP_CONNECT		Search Response of Connector	20091012

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20091012

Method TAKE_OVER_RANK_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESP_CONNECT		Search Response of Connector	20091023
2	Exporting	EV_SUCCEEDED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20091023

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20091023

History

Last changed by/on	SAP	20110908
SAP Release Created in	712