SAP ABAP Class CL_ESH_OS_RESPONSE_BUILDER (OS Response Builder)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_IF_OPEN_SEARCH (Package) Open Search Service

Properties

Class	CL_ESH_OS_RESPONSE_BUILDER
Short Description	OS Response Builder
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_IF_OPEN_SEARCH	Open Search Service
Created	20081020	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)
2	CL_ABAP_CHAR_UTILITIES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_ESH_SE_RUNTIME_DATA	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_ESH_OS_RESPONSE_BUILDER has no interface implemented.

Friends

Class CL_ESH_OS_RESPONSE_BUILDER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CV_LF	Constant	Public	☐	Type reference (TYPE)	CHAR2	CL_ABAP_CHAR_UTILITIES=>CR_LF	Line feed	20081020
2	CV_RESPONSE_TYPE_ATOM	Constant	Public	☐	Type reference (TYPE)	ESH_E_OS_RESPONSE_TYPE	'ATOM'	OpenSearch response type ATOM	20081020
3	CV_RESPONSE_TYPE_HTML	Constant	Public	☐	Type reference (TYPE)	ESH_E_OS_RESPONSE_TYPE	'HTML'	OpenSearch response type HTML	20081021
4	CV_RESPONSE_TYPE_JSON	Constant	Public	☐	Type reference (TYPE)	ESH_E_OS_RESPONSE_TYPE	'JSON'	OpenSearch response type JSON	20090323
5	CV_RESPONSE_TYPE_RSS	Constant	Public	☐	Type reference (TYPE)	ESH_E_OS_RESPONSE_TYPE	'RSS'	OpenSearch response type RSS	20081020
6	CV_RESPONSE_TYPE_VALUEHELP	Constant	Public	☐	Type reference (TYPE)	ESH_E_OS_RESPONSE_TYPE	'F4'	OpenSearch response type JSON	20100901
7	CV_SPACE	Constant	Public	☐	Type reference (TYPE)	CHAR2	SPACE	Space	20081024
8	CV_STATUS_FAILED	Constant	Public	☐	Type reference (TYPE)	STRING	'Failed'	Connector status failed	20090608
9	CV_STATUS_SUCCESS	Constant	Public	☐	Type reference (TYPE)	STRING	'Success'	Connector status success	20090608
10	CV_STATUS_TIMEOUT	Constant	Public	☐	Type reference (TYPE)	STRING	'Timeout'	Connector status timeout	20090608
11	MR_DOM	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20081210
12	MR_IXML	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML		IF_IXML	20081210
13	MR_REQUEST	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_REQUEST		Search request	20081020
14	MR_RESPONSES	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSES		Search responses	20081020
15	MT_UI_TECH_RESTRICTIONS	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_IF_TARGET_UI_TYPES		UI technology restrictions	20100719
16	MV_CATEGORY	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Category	20090323
17	MV_CONNECTOR	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Connector	20090323
18	MV_COUNT	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Requested number of results	20090323
19	MV_HIGHLIGHT_TERMS	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Highlight terms for getContent	20100302
20	MV_INCLUDE_ATTRIBUTES	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Include attributes	20081212
21	MV_QUERY	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Query	20090323
22	MV_REQUEST_ATTRIBUTE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100223
23	MV_REQUEST_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Request type	20090323
24	MV_START_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Start index	20090323
25	MV_START_PAGE	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Start page	20090323
26	MV_SWITCH_OFF_INT_NAV	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Switch off interactive navigation	20090323
27	MV_TEMPLATE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Template	20090323
28	MV_XML_STYLESHEET	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20090107

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ALL_SUBSET_QUERIES	Instance method	Private	Method	Calculate and add the set of subset queries	20081212
2	ADD_ATTRIBUTE_SECTION	Instance method	Private	Method	Get a result section	20081212
3	ADD_AUTODISCOVERY_SECTION	Instance method	Private	Method	Get Autodiscovery section	20081212
4	ADD_CATEGORY_SECTION	Instance method	Private	Method	Get a result section	20090126
5	ADD_GET_CONTENTS	Instance method	Private	Method	Add links	20100212
6	ADD_HEADER_SECTION	Instance method	Private	Method	Get the header section	20081212
7	ADD_LINKS	Instance method	Private	Method	Add links	20090227
8	ADD_QUERY_ELEMENT	Instance method	Private	Method	Add a subset query to the response	20090226
9	ADD_RESULT_SECTION	Instance method	Private	Method	Get a result section	20081212
10	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20081020
11	GET_CATEGORIES	Instance method	Private	Method	Append template information	20090126
12	GET_RELATED_REQUEST	Instance method	Private	Method	Get related request	20090227
13	GET_RESPONSE	Instance method	Public	Method	Get the OpenSearch search response	20081020
14	GET_SEARCHTERM_BY_DISTRIBUTION	Instance method	Private	Method	Get search terms by distribution	20081212
15	GET_VALUE_HELP	Instance method	Public	Method	Suggest	20100223
16	SEARCH	Instance method	Public	Method	Search	20090202
17	SUGGEST	Instance method	Public	Method	Suggest	20090323

Events

Class CL_ESH_OS_RESPONSE_BUILDER has no event.

Types

Class CL_ESH_OS_RESPONSE_BUILDER has no local type.

Method Signatures

Method ADD_ALL_SUBSET_QUERIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_HEADER	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212

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

Method ADD_ATTRIBUTE_SECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_RESPONSE_ATTR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE		Meta Data: Attribute Type	20081212
2	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212
3	Importing	IV_ATTR_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20081212

Method ADD_ATTRIBUTE_SECTION on class CL_ESH_OS_RESPONSE_BUILDER has no exception.

Method ADD_AUTODISCOVERY_SECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_HEADER	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212
2	Importing	IV_RESPONSE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OS_RESPONSE_TYPE			20081212

Method ADD_AUTODISCOVERY_SECTION on class CL_ESH_OS_RESPONSE_BUILDER has no exception.

Method ADD_CATEGORY_SECTION 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)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20090126
2	Importing	IV_SEARCH_CONNECTOR	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID			20090126

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

Method ADD_GET_CONTENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_RESULT_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20100212
2	Importing	IR_SEARCH_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20100212

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

Method ADD_HEADER_SECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_HEADER	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212
2	Importing	IR_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSE		Search Response	20081212
3	Importing	IR_RESPONSES	Call by reference	☑	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESPONSES		Search Responses	20090608
4	Importing	IV_RESPONSE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OS_RESPONSE_TYPE		Open Search response type	20081212

Method ADD_HEADER_SECTION on class CL_ESH_OS_RESPONSE_BUILDER has no exception.

Method ADD_LINKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_RESULT_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20090227
2	Importing	IR_SEARCH_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20090227

Method ADD_LINKS on class CL_ESH_OS_RESPONSE_BUILDER has no exception.

Method ADD_QUERY_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_HEADER	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20090226
2	Importing	IV_ATTRIBUTE	Call by reference	☑	Type reference (TYPE)	STRING			20100929
3	Importing	IV_ATTR_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING			20100929
4	Importing	IV_REQUEST	Call by reference	☑	Type reference (TYPE)	STRING			20090504
5	Importing	IV_ROLE	Call by reference	☐	Type reference (TYPE)	STRING			20090226
6	Importing	IV_SCOPE	Call by reference	☑	Type reference (TYPE)	STRING			20090504
7	Importing	IV_SEARCH_TERMS	Call by reference	☐	Type reference (TYPE)	STRING			20090226
8	Importing	IV_TITLE	Call by reference	☑	Type reference (TYPE)	STRING			20090226
9	Importing	IV_TOTAL_RESULTS	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20090226
10	Importing	IV_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20100929
11	Importing	IV_VALUE_FROM	Call by reference	☑	Type reference (TYPE)	STRING			20100929
12	Importing	IV_VALUE_TO	Call by reference	☑	Type reference (TYPE)	STRING			20100929

Method ADD_QUERY_ELEMENT on class CL_ESH_OS_RESPONSE_BUILDER has no exception.

Method ADD_RESULT_SECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_HEADER	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212
2	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20081212
3	Importing	IV_RESPONSE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OS_RESPONSE_TYPE		Open Search response type	20081212

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

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_UI_TECH_RESTRICTIONS	Call by reference	☑	Type reference (TYPE)	ESH_T_IF_TARGET_UI_TYPES		Navigation Target UI Type list	20100719
2	Importing	IV_CATEGORY	Call by reference	☑	Type reference (TYPE)	STRING			20090202
3	Importing	IV_COMPATIBILITY_MODE	Call by reference	☑	Type reference (TYPE)	STRING			20090120
4	Importing	IV_CONNECTOR	Call by reference	☑	Type reference (TYPE)	STRING			20090202
5	Importing	IV_COUNT	Call by reference	☐	Type reference (TYPE)	INT4	10	Natural number	20090202
6	Importing	IV_HIGHLIGHT_TERMS	Call by reference	☑	Type reference (TYPE)	STRING			20100302
7	Importing	IV_INCLUDE_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Include Attributes	20081024
8	Importing	IV_QUERY	Call by reference	☑	Type reference (TYPE)	STRING			20090202
9	Importing	IV_REQUEST_ATTRIBUTE	Call by reference	☑	Type reference (TYPE)	STRING			20100223
10	Importing	IV_REQUEST_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20090202
11	Importing	IV_START_INDEX	Call by reference	☐	Type reference (TYPE)	INT4	1	Natural number	20090202
12	Importing	IV_START_PAGE	Call by reference	☐	Type reference (TYPE)	INT4	1	Natural number	20090202
13	Importing	IV_SWITCH_OFF_INT_NAV	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090319
14	Importing	IV_TEMPLATE	Call by reference	☑	Type reference (TYPE)	STRING			20090202
15	Importing	IV_XML_STYLESHEET	Call by reference	☑	Type reference (TYPE)	STRING			20090107

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

Method GET_CATEGORIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CATEGORIES	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_CATEGORIES_SORTED		Categories (sorted)	20090126
2	Exporting	ET_TEMPLATES	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_TEMPLATES_SORTED		Templates (sorted)	20090504
3	Importing	IS_CONNECTOR	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED		Connector (sorted)	20090126

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

Method GET_RELATED_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SEARCH_TERMS	Call by reference	☐	Type reference (TYPE)	STRING			20090603
2	Exporting	EV_URL	Call by reference	☐	Type reference (TYPE)	STRING			20090603
3	Importing	IR_SEARCH_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_SEARCH_RESULT		Search Result	20090227
4	Importing	IS_RELATED_REQUEST	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_REL_REQUEST_LIST		Related Search Connector Request List	20090227

Method GET_RELATED_REQUEST on class CL_ESH_OS_RESPONSE_BUILDER has no exception.

Method GET_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RESPONSE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OS_RESPONSE_TYPE		Open Search response type	20081020
2	Exporting	RV_RESULT	Call by reference	☐	Type reference (TYPE)	STRING			20081020
3	Exporting	RV_XRESULT	Call by reference	☐	Type reference (TYPE)	XSTRING			20100118

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

Method GET_SEARCHTERM_BY_DISTRIBUTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DISTRIBUTION	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_SCOPE_DISTRIBUTION		Distribution statistics of results	20081212
2	Returning	RV_SEARCH_TERMS	Value transfer	☐	Type reference (TYPE)	STRING			20081212

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

Method GET_VALUE_HELP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SUGGESTIONS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_SUGGESTIONS		Suggestions for a search input	20100223
2	Importing	IV_CATEGORY	Call by reference	☑	Type reference (TYPE)	STRING			20100223
3	Importing	IV_CONNECTOR	Call by reference	☑	Type reference (TYPE)	STRING			20100223
4	Importing	IV_COUNT	Call by reference	☐	Type reference (TYPE)	INT4	10	Natural number	20100223
5	Importing	IV_QUERY	Call by reference	☐	Type reference (TYPE)	STRING			20100223
6	Importing	IV_REQUEST_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	STRING		Attribute ID	20100223
7	Importing	IV_REQUEST_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20100223
8	Importing	IV_TEMPLATE	Call by reference	☑	Type reference (TYPE)	STRING			20100223

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

Method SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CATEGORY	Call by reference	☑	Type reference (TYPE)	STRING			20090202
2	Importing	IV_CONNECTOR	Call by reference	☑	Type reference (TYPE)	STRING			20090202
3	Importing	IV_COUNT	Call by reference	☐	Type reference (TYPE)	INT4	10	Natural number	20090202
4	Importing	IV_GET_CONTENT_ATTRIBUTE	Call by reference	☑	Type reference (TYPE)	STRING		GetContent Attribute	20100224
5	Importing	IV_HIGHLIGHT_TERMS	Call by reference	☑	Type reference (TYPE)	STRING		GetContent Highlight Terms	20100302
6	Importing	IV_QUERY	Call by reference	☐	Type reference (TYPE)	STRING			20090202
7	Importing	IV_REQUEST_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20090202
8	Importing	IV_START_INDEX	Call by reference	☐	Type reference (TYPE)	INT4	1	Natural number	20090202
9	Importing	IV_START_PAGE	Call by reference	☐	Type reference (TYPE)	INT4	1	Natural number	20090202
10	Importing	IV_SWITCH_OFF_INT_NAV	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20090319
11	Importing	IV_TEMPLATE	Call by reference	☑	Type reference (TYPE)	STRING			20090202

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

Method SUGGEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SUGGESTIONS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_SUGGESTIONS		Suggestions for a search input	20090323
2	Importing	IV_CATEGORY	Call by reference	☑	Type reference (TYPE)	STRING			20090323
3	Importing	IV_CONNECTOR	Call by reference	☑	Type reference (TYPE)	STRING			20090323
4	Importing	IV_COUNT	Call by reference	☐	Type reference (TYPE)	INT4	10	Natural number	20090323
5	Importing	IV_QUERY	Call by reference	☐	Type reference (TYPE)	STRING			20090323
6	Importing	IV_REQUEST_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20090323
7	Importing	IV_TEMPLATE	Call by reference	☑	Type reference (TYPE)	STRING			20090323

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

History

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