SAP ABAP Class CL_ESH_IF_SEARCH_RESULT (Search Result)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_INTERFACE (Package) Interface

Properties

Class	CL_ESH_IF_SEARCH_RESULT
Short Description	Search Result
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_INTERFACE	Interface
Created	20080117	SAP
Last change	20130531	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_IF_SEARCH_RESULT has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_FED_RESULT_BUILDER	☐	20081009	Result Builder
2	CL_ESH_IF_SEARCH_RESPONSE	☐	20080117	Search Response
3	CL_ESH_IF_SEARCH_RESP_CONNECT	☐	20080814	Search Response of Connector

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_ROWTYPE_ATTRIBUTE	Constant	Public	☐	Type reference (TYPE)	TREXD_ROWTYPE	'ATTRIBUTE'	Rowtype attribute	20100517
2	MR_RESPONSE_GROUP	Instance attribute	Private	☐	Object reference (TYPE REF TO)	ESH_S_IF_GROUPED_RESULT_DATA		Reference to the related response group	20080814
3	MV_ENRICHMENT_DONE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Enrichment is done	20090902
4	MV_POSITION_IN_GROUP	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Position in response group	20080814

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_ATTRIBUTES	Instance method	Public	Method	Get response attribute names available in the result	20080814
2	GET_ATTRIBUTE_DESCRIPTION	Instance method	Public	Method	Get attribute description (in logon language)	20081016
3	GET_ATTRIBUTE_VALUE	Instance method	Public	Method	Get value of attribute in the result	20080814
4	GET_ATTRIBUTE_VALUE_TYPED	Instance method	Public	Method	Get value of attribute in the result	20090202
5	GET_CONNECTOR	Instance method	Public	Method	Get connector	20080821
6	GET_CONTENT_SNIPPET	Instance method	Public	Method	Get content snippet	20080822
7	GET_DATA	Instance method	Public	Method	Get result data	20080117
8	GET_HIT_ATTRIBUTES	Instance method	Public	Method	Get hit request attributes	20100823
9	GET_ICON	Instance method	Public	Method	Get rank value	20081204
10	GET_INSTANCE	Static method	Protected	Method	Factory	20080125
11	GET_IQ_COMPLEX_ATTR_CONDITION	Instance method	Protected	Method	Get a complex attribute condition in internal format	20130215
12	GET_IQ_OPERATOR	Instance method	Protected	Method	Get a query line with bracket	20100517
13	GET_IQ_SEARCH_TEXT_ENTRY	Instance method	Protected	Method	Get a query entry for text search	20130215
14	GET_IQ_SIMPLE_ATTR_CONDITION	Instance method	Protected	Method	Get simple attribute condition in internal format	20100517
15	GET_NAVIGATION_URLS	Instance method	Public	Method	Get URL for navigation	20081013
16	GET_NUMBER_OF_TOTAL_RESULTS	Instance method	Public	Method	Get number of total results (needed for suggest)	20121119
17	GET_RANK_VALUE	Instance method	Public	Method	Get rank value	20080822
18	GET_RELATED_REQUEST	Instance method	Public	Method	Get related request	20081218
19	GET_RELATED_REQUEST_CONDITIONS	Instance method	Public	Method	Get related request conditions	20100517
20	GET_REQ_ATTR_CONTENT	Instance method	Private	Method	Get request attribute content	20100212
21	GET_SNIPPET_BY_HIT_ATTRIBUTE	Instance method	Public	Method	Get snippet of the hit attribute value	20100823
22	LIST_RELATED_REQUESTS	Instance method	Public	Method	Get URL for navigation	20081218
23	LIST_REQ_ATTRS_FOR_GETCONTENT	Instance method	Private	Method	List request attributes that provide content	20100212

Events

Class CL_ESH_IF_SEARCH_RESULT has no event.

Types

Class CL_ESH_IF_SEARCH_RESULT has no local type.

Method Signatures

Method GET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTR_NAMES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20080814

Method GET_ATTRIBUTES on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_ATTRIBUTE_DESCRIPTION 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	20081016
2	Returning	RV_DESCRIPTION	Value transfer	☐	Type reference (TYPE)	ESH_E_IF_NAME		Readable Name	20081016

Method GET_ATTRIBUTE_DESCRIPTION on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_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	20080814
2	Returning	RV_ATTRIBUTE_VALUE	Value transfer	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_VALUE		Attribute Value	20080814

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

Method GET_ATTRIBUTE_VALUE_TYPED 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	20090202
2	Returning	RR_ATTRIBUTE_VALUE	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Attribute Value	20090202

Method GET_ATTRIBUTE_VALUE_TYPED on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_CONNECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONNECTOR_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_NAME		Readable Name	20081016
2	Exporting	EV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20080821
3	Exporting	EV_REQUEST_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request Type ID	20080821

Method GET_CONNECTOR on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_CONTENT_SNIPPET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CONTENT_SNIPPET	Value transfer	☐	Type reference (TYPE)	ESH_E_IF_CONTENT_SNIPPET		Content Snippet	20080822

Method GET_CONTENT_SNIPPET on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20080117

Method GET_DATA on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_HIT_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTR_NAMES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20100823

Method GET_HIT_ATTRIBUTES on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ICON	Value transfer	☐	Type reference (TYPE)	ESH_E_IF_WEB_ICON		Icon	20081204

Method GET_ICON on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_RESPONSE_GROUP	Call by reference	☐	Object reference (TYPE REF TO)	ESH_S_IF_GROUPED_RESULT_DATA		Grouped Result List - holds results per connector (request)	20080814
2	Importing	IV_POSITION_IN_GROUP	Call by reference	☐	Type reference (TYPE)	INT4		Position in group	20080814
3	Returning	RO_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20080125

Method GET_INSTANCE on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_IQ_COMPLEX_ATTR_CONDITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_QUERY_ENTRY	Value transfer	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20130215
2	Importing	IS_SELECT_OPTION	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_SELECT_OPTIONS		Structure for select options	20130215
3	Importing	IV_ATTRIBUTE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME		Attribute Name	20130215
4	Importing	IV_CONTENT_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_CONTENT_TYPE		Content Type	20130215
5	Importing	IV_SEARCH_MODE	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_SEARCH_MODE		Search Mode	20130215

Method GET_IQ_COMPLEX_ATTR_CONDITION on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_IQ_OPERATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_QUERY_ENTRY	Value transfer	☐	Type reference (TYPE)	ESH_S_FED_QUERY_ENTRY		Query Entry	20100517
2	Importing	IV_OPERATOR	Call by reference	☐	Type reference (TYPE)	STRING		Operator (AND, OR)	20100517
3	Importing	IV_QUERY_PART	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20100517

Method GET_IQ_OPERATOR on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_IQ_SEARCH_TEXT_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_QUERY_ENTRY	Value transfer	☐	Type reference (TYPE)	ESH_S_FED_QUERY_ENTRY		Query Entry	20130215
2	Importing	IV_FOR_FREESTYLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20130215
3	Importing	IV_SEARCH_MODE	Call by reference	☑	Type reference (TYPE)	TREXD_TERM_ACTION		Term action (Exact, fuzzy, linquistic search)	20130215
4	Importing	IV_SEARCH_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20130215

Method GET_IQ_SEARCH_TEXT_ENTRY on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_IQ_SIMPLE_ATTR_CONDITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_QUERY_ENTRY	Value transfer	☐	Type reference (TYPE)	ESH_S_FED_QUERY_ENTRY		Query Entry	20100517
2	Importing	IV_ATTRIBUTE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME			20100517
3	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_VALUE		Attribute Value	20100517

Method GET_IQ_SIMPLE_ATTR_CONDITION on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_NAVIGATION_URLS Signature

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

Method GET_NAVIGATION_URLS on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_NUMBER_OF_TOTAL_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NO_OF_TOTAL_RESULTS	Value transfer	☐	Type reference (TYPE)	ESH_E_IF_NO_OF_TOTAL_RESULTS		Total Number of Results	20121119

Method GET_NUMBER_OF_TOTAL_RESULTS on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_RANK_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RANK	Value transfer	☐	Type reference (TYPE)	ESH_E_IF_RANK_VALUE		Rank Value for Results List	20080822

Method GET_RANK_VALUE on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method GET_RELATED_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_RELATED_REQUEST	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_REL_REQUEST_LIST			20081218
2	Returning	RR_RELATED_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_REQUEST			20081218

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

Method GET_RELATED_REQUEST_CONDITIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CONDITIONS	Call by reference	☐	Type reference (TYPE)	TREXT_QUERY_ENTRIES		Search Query	20100517
2	Importing	IS_RELATED_REQUEST	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_REL_REQUEST_LIST			20100517

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

Method GET_REQ_ATTR_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONTENT	Call by reference	☐	Type reference (TYPE)	STRING			20100212
2	Importing	IV_HIGHLIGHT_TERMS	Call by reference	☑	Type reference (TYPE)	STRING			20100212
3	Importing	IV_REQUEST_ATTRIBUTE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_ID		Attribute ID	20100212

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

Method GET_SNIPPET_BY_HIT_ATTRIBUTE 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	20100823
2	Returning	RV_SNIPPET	Value transfer	☐	Type reference (TYPE)	STRING			20100823

Method GET_SNIPPET_BY_HIT_ATTRIBUTE on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method LIST_RELATED_REQUESTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RELATED_REQUESTS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_REL_REQUEST_LIST			20081218

Method LIST_RELATED_REQUESTS on class CL_ESH_IF_SEARCH_RESULT has no exception.

Method LIST_REQ_ATTRS_FOR_GETCONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_REQ_ATTRS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20100212

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

History

Last changed by/on	SAP	20130531
SAP Release Created in	711