SAP ABAP Class CL_ESH_FED_RESULT_BUILDER (Result 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_RESULT_BUILDER
Short Description	Result 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_RESULT_BUILDER has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_FED_GRP_RESP_BUILDER	☐	20080813	Grouped Response Builder
2	CL_ESH_FED_RESPONSE_ENRICHER	☐	20100914	Response Enricher
3	CL_ESH_FED_RESULT_ASSEMBLER	☐	20090902	Result Assembler

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_RESULT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Result reference	20081009
2	MT_ATTRIBUTE_VALUES	Instance attribute	Protected	☐	Type reference (TYPE)	LTY_T_ATTRIBUTE_VALUES		Attribute values	20080812
3	MT_NAVIGATION_URLS	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_T_IF_NAVIGATION_URLS		URLs in Enterprise Search (optional)	20081013
4	MV_CONNECTOR_ID	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search connector ID	20080812
5	MV_CONTENT_SNIPPET	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_IF_CONTENT_SNIPPET		Content snippet	20080812
6	MV_ICON	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_IF_WEB_ICON		Icon	20081204
7	MV_RANK_VALUE	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_IF_RANK_VALUE		Rank value for results list	20080812
8	MV_REQUEST_TYPE_ID	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request type ID	20080812

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20080812
2	GET_ENRICHMENT_DONE	Instance method	Public	Method	Enrichment is done	20090902
3	SET_ATTRIBUTE_VALUE	Instance method	Public	Method	Set attribute value	20080812
4	SET_CONTENT_SNIPPET	Instance method	Public	Method	Set content snippet	20080812
5	SET_ENRICHMENT_DONE	Instance method	Protected	Method	Set enrichment is done	20090902
6	SET_ICON	Instance method	Public	Method	Set icon	20081204
7	SET_NAVIGATION_URLS	Instance method	Public	Method	Set navigation URLs	20081013
8	SET_RANK_VALUE	Instance method	Public	Method	Set rank value	20080812

Events

Class CL_ESH_FED_RESULT_BUILDER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LTY_S_ATTRIBUTE_VALUE	Protected	See coding			20080813	BEGIN OF lty_s_attribute_value, attribute_name TYPE esh_e_if_attribute_name, attribute_value TYPE esh_e_if_attribute_value, END OF lty_s_attribute_value
2	LTY_T_ATTRIBUTE_VALUES	Protected	See coding			20080813	lty_t_attribute_values TYPE TABLE OF lty_s_attribute_value

Method Signatures

Method CONSTRUCTOR 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_IF_SEARCH_RESULT		Search result	20081009
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

Method CONSTRUCTOR on class CL_ESH_FED_RESULT_BUILDER has no exception.

Method GET_ENRICHMENT_DONE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ENRICHMENT_DONE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090902

Method GET_ENRICHMENT_DONE on class CL_ESH_FED_RESULT_BUILDER has no exception.

Method SET_ATTRIBUTE_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTRIBUTE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME		Attribute name	20080812
2	Importing	IV_ATTRIBUTE_VALUE	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_VALUE		Attribute value	20080812

Method SET_ATTRIBUTE_VALUE on class CL_ESH_FED_RESULT_BUILDER has no exception.

Method SET_CONTENT_SNIPPET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTENT_SNIPPET	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_CONTENT_SNIPPET		Content snippet	20080812

Method SET_CONTENT_SNIPPET on class CL_ESH_FED_RESULT_BUILDER has no exception.

Method SET_ENRICHMENT_DONE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENRICHMENT_DONE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Enrichment done	20090902

Method SET_ENRICHMENT_DONE on class CL_ESH_FED_RESULT_BUILDER has no exception.

Method SET_ICON 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 on class CL_ESH_FED_RESULT_BUILDER has no exception.

Method SET_NAVIGATION_URLS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_URLS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_NAVIGATION_URLS		URLs in Enterprise Search (optional)	20081013

Method SET_NAVIGATION_URLS on class CL_ESH_FED_RESULT_BUILDER has no exception.

Method SET_RANK_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RANK_VALUE	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_RANK_VALUE		Rank value for results list	20080812

Method SET_RANK_VALUE on class CL_ESH_FED_RESULT_BUILDER has no exception.

History

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