SAP ABAP Class CL_ESH_TAU_OS_SEARCH (Description Service (OpenSearch - RSS))

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_TST_AUTOMATION (Package) Test Automation

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_HTTP_EXTENSION	HTTP Framework (iHTTP) HTTP Request Handler	20091117

Properties

Class	CL_ESH_TAU_OS_SEARCH
Short Description	Description Service (OpenSearch - RSS)
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_TST_AUTOMATION	Test Automation
Created	20091117	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_TAU_OS_SEARCH has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_HTTP_EXTENSION	☐	☐	HTTP Framework (iHTTP) HTTP Request Handler	20091117

Friends

Class CL_ESH_TAU_OS_SEARCH has no friend class.

Attributes

Class CL_ESH_TAU_OS_SEARCH has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_EPM_DATA	Static method	Protected	Method		20091118
2	GET_RESULTS_FEED	Instance method	Protected	Method	Return search results as OpenSearch (RSS 2.0 or ATOM Feed)	20091118
3	GET_SEARCHURL	Static method	Protected	Method		20091117
4	REPLACE_PLACEHOLDER	Static method	Private	Method	Replace placeholder of parameter with value if not initial	20091117

Events

Class CL_ESH_TAU_OS_SEARCH has no event.

Types

Class CL_ESH_TAU_OS_SEARCH has no local type.

Method Signatures

Method GET_EPM_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_EPM_DATA	Call by reference	☐	Type reference (TYPE)	ESH_T_ADPT_OS_RESULTS		Open Search results	20091118
2	Exporting	EV_TOTAL_RESULTS	Call by reference	☐	Type reference (TYPE)	I			20091118
3	Importing	IV_COUNT	Call by reference	☑	Type reference (TYPE)	I			20091118
4	Importing	IV_SEARCHTERMS	Call by reference	☑	Type reference (TYPE)	STRING		Query	20091118
5	Importing	IV_STARTINDEX	Call by reference	☑	Type reference (TYPE)	I			20091118
6	Importing	IV_STARTPAGE	Call by reference	☑	Type reference (TYPE)	I			20091118

Method GET_EPM_DATA on class CL_ESH_TAU_OS_SEARCH has no exception.

Method GET_RESULTS_FEED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_XDATA	Value transfer	☐	Type reference (TYPE)	XSTRING		utf-8 xml rss-feed	20091118
2	Importing	IT_RESULTS	Call by reference	☐	Type reference (TYPE)	ESH_T_ADPT_OS_RESULTS		Open Search results	20091118
3	Importing	IV_COUNT	Call by reference	☑	Type reference (TYPE)	I		number of results per page	20091118
4	Importing	IV_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING			20091118
5	Importing	IV_DESCRIPTIONURL	Call by reference	☐	Type reference (TYPE)	STRING		the relative path to the description xml	20091118
6	Importing	IV_FORMAT	Call by reference	☐	Type reference (TYPE)	STRING		rss, atom, html	20091118
7	Importing	IV_SEARCHTERMS	Call by reference	☐	Type reference (TYPE)	STRING		search query	20091118
8	Importing	IV_SEARCHURL	Call by reference	☐	Type reference (TYPE)	STRING			20091118
9	Importing	IV_STARTINDEX	Call by reference	☑	Type reference (TYPE)	I		the index of the first item returned in the result.	20091118
10	Importing	IV_STYLESHEETURL	Call by reference	☑	Type reference (TYPE)	STRING		the stylsheet which will be linked within the output xml	20091118
11	Importing	IV_TITLE	Call by reference	☐	Type reference (TYPE)	STRING			20091118
12	Importing	IV_TOTALRESULTS	Call by reference	☑	Type reference (TYPE)	I		the maximum number of results to be returned for this search	20091118

#	Exception	Resumable	Description	Created on
1	CX_DYNAMIC_CHECK	☐	General Error When Performing CALL TRANSFORMATION	20091118

Method GET_SEARCHURL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_URL	Value transfer	☐	Type reference (TYPE)	STRING			20091117
2	Importing	IV_COUNT	Call by reference	☑	Type reference (TYPE)	STRING			20091117
3	Importing	IV_HOST	Call by reference	☑	Type reference (TYPE)	STRING			20091117
4	Importing	IV_INPUTENCODING	Call by reference	☑	Type reference (TYPE)	STRING			20091117
5	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	STRING			20091117
6	Importing	IV_OBJECTTYPE	Call by reference	☑	Type reference (TYPE)	STRING			20091117
7	Importing	IV_OUTPUTENCODING	Call by reference	☑	Type reference (TYPE)	STRING			20091117
8	Importing	IV_SEARCHTEMPLATE	Call by reference	☑	Type reference (TYPE)	STRING		optional template url to be used (as source for replace)	20091117
9	Importing	IV_SEARCHTERMS	Call by reference	☑	Type reference (TYPE)	STRING			20091117
10	Importing	IV_SERVICE	Call by reference	☑	Type reference (TYPE)	STRING			20091117
11	Importing	IV_STARTINDEX	Call by reference	☑	Type reference (TYPE)	STRING			20091117
12	Importing	IV_STARTPAGE	Call by reference	☑	Type reference (TYPE)	STRING			20091117

Method GET_SEARCHURL on class CL_ESH_TAU_OS_SEARCH has no exception.

Method REPLACE_PLACEHOLDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_REPLACED_SEARCHURL	Value transfer	☐	Type reference (TYPE)	STRING			20091117
2	Importing	IV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20091117
3	Importing	IV_FIELD_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20091117
4	Importing	IV_SEARCHURL	Call by reference	☐	Type reference (TYPE)	STRING			20091117

Method REPLACE_PLACEHOLDER on class CL_ESH_TAU_OS_SEARCH has no exception.

History

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