SAP ABAP Class CL_ESH_ADAPT_OPEN_SEARCH (Open Search Adapter)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_CONTENT_FED_ADAPTERS (Package) Adapters for Federated Search

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_FED_ADAPTER_FEATURES	Federation Search - Adapter Features	20080814
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_FED_FEDERATION_SEARCH	Federation Search Interface	20080814

Properties

Class	CL_ESH_ADAPT_OPEN_SEARCH
Short Description	Open Search Adapter
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_CONTENT_FED_ADAPTERS	Adapters for Federated Search
Created	20080814	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_ADAPT_OPEN_SEARCH has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_FED_ADAPTER_FEATURES	☐	☐	Federation Search - Adapter Features	20080814
2	IF_ESH_FED_FEDERATION_SEARCH	☐	☐	Federation Search Interface	20080814

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_ADAPT_CONN_MGR_OS	☐	20081031	Adapter Connectivity Mgr. for Open Search

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_PARAM_COUNT	Constant	Private	☐	Type reference (TYPE)	STRING	'count'		20080814
2	MC_PARAM_INPUTENCODING	Constant	Private	☐	Type reference (TYPE)	STRING	'inputEncoding'		20080814
3	MC_PARAM_LANGUAGE	Constant	Private	☐	Type reference (TYPE)	STRING	'language'		20080814
4	MC_PARAM_OUTPUTENCODING	Constant	Private	☐	Type reference (TYPE)	STRING	'outputEncoding'		20080814
5	MC_PARAM_SEARCHTERMS	Constant	Private	☐	Type reference (TYPE)	STRING	'searchTerms'		20080814
6	MC_PARAM_STARTINDEX	Constant	Private	☐	Type reference (TYPE)	STRING	'startIndex'		20080814
7	MC_PARAM_STARTPAGE	Constant	Private	☐	Type reference (TYPE)	STRING	'startPage'		20080814

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALL_HTTP	Static method	Protected	Method	Execute HTTP request and return source of HTTP page/XML	20080814
2	CALL_HTTP_BY_DEST	Static method	Protected	Method	Execute HTTP request and return source of HTTP page/XML	20081029
3	EXECUTE_SEARCH_CALL	Instance method	Private	Method	Read OpenSearch description	20080814
4	FILL_URL_TEMPLATE_FROM_REQUEST	Instance method	Private	Method	Build OpenSearch URL from request data	20080814
5	GET_DESTINATION_FROM_SCOPE	Instance method	Private	Method	Get the OpenSearch URL from the scope metadata	20081104
6	GET_PARAM_LIST_OF_URL_TEMLATE	Instance method	Private	Method	Get the parameter list of an OpenSearch URL template	20080814
7	READ_QUERY_FROM_REQUEST	Instance method	Private	Method	Read the textual part of the query from the request object	20080814

Events

Class CL_ESH_ADAPT_OPEN_SEARCH has no event.

Types

Class CL_ESH_ADAPT_OPEN_SEARCH has no local type.

Method Signatures

Method CALL_HTTP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CDATA	Call by reference	☐	Type reference (TYPE)	STRING			20090908
2	Exporting	EV_XDATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20080814
3	Importing	IV_CONTENT_PROXY	Call by reference	☑	Type reference (TYPE)	STRING			20080814
4	Importing	IV_CONTENT_PROXYPORT	Call by reference	☑	Type reference (TYPE)	STRING			20080814
5	Importing	IV_URL	Call by reference	☐	Type reference (TYPE)	STRING			20080814

Method CALL_HTTP on class CL_ESH_ADAPT_OPEN_SEARCH has no exception.

Method CALL_HTTP_BY_DEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CDATA	Call by reference	☐	Type reference (TYPE)	STRING			20090908
2	Exporting	EV_XDATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20081029
3	Importing	IV_DEST	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20081029
4	Importing	IV_PATH	Call by reference	☑	Type reference (TYPE)	STRING			20081029
5	Importing	IV_TIMEOUT	Call by reference	☐	Type reference (TYPE)	I	5		20081211

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADAPT_EXCEPTION	☐	Exception in the Adapter	20081103

Method EXECUTE_SEARCH_CALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_STATISTICS	Call by reference	☐	Type reference (TYPE)	ESH_S_ADPT_OS_STATISTICS		Open Search Statistics	20080814
2	Exporting	ET_RESULTS	Call by reference	☐	Type reference (TYPE)	ESH_T_ADPT_OS_RESULTS		Open Search Results	20080814
3	Importing	IV_DESTINATION	Call by reference	☐	Type reference (TYPE)	ESH_E_ADAPT_CONN_HTTP_DEST			20081104
4	Importing	IV_PATH_TEMPLATE	Call by reference	☐	Type reference (TYPE)	ESH_E_ADAPT_CONN_HTTP_PATH			20081104
5	Importing	IV_TIMEOUT	Call by reference	☐	Type reference (TYPE)	I	5		20081211
6	Importing	IV_XML_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_ADAPT_CONN_XML_TYPE			20081104

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADAPT_EXCEPTION	☐	Exception in the Adapter	20090109

Method FILL_URL_TEMPLATE_FROM_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SUPPORTS_COUNT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20081208
2	Exporting	EV_SUPPORTS_STARTINDEX	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20081208
3	Exporting	EV_SUPPORTS_STARTPAGE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20081208
4	Exporting	EV_URL	Call by reference	☐	Type reference (TYPE)	STRING			20081208
5	Importing	IR_REQUEST_DATA	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_FED_REQUEST_DATA		Search Request Data	20080814
6	Importing	IV_FORCE_COUNT	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20081208
7	Importing	IV_URL_TEMPLATE	Call by reference	☐	Type reference (TYPE)	STRING			20080814

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

Method GET_DESTINATION_FROM_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DESTINATION	Call by reference	☐	Type reference (TYPE)	ESH_E_ADAPT_CONN_HTTP_DEST		HTTP Destination	20081104
2	Exporting	EV_PATH_TEMPLATE	Call by reference	☐	Type reference (TYPE)	ESH_E_ADAPT_CONN_HTTP_PATH		HTTP Relative Path	20081104
3	Exporting	EV_XML_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_ADAPT_CONN_XML_TYPE		XML Open Search Response Type	20081104
4	Importing	IT_SCOPE	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_SCOPE		Search Scope	20081104

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADAPT_EXCEPTION	☐	Exception in the Adapter	20081104

Method GET_PARAM_LIST_OF_URL_TEMLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PARAMS	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20080814
2	Importing	IV_URL_TEMPLATE	Call by reference	☐	Type reference (TYPE)	STRING			20080814

Method GET_PARAM_LIST_OF_URL_TEMLATE on class CL_ESH_ADAPT_OPEN_SEARCH has no exception.

Method READ_QUERY_FROM_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	20080814
2	Returning	RV_QUERY_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20080814

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

History

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