SAP ABAP Class CL_ESH_ADAPT_FS (File 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	20080812
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_FED_FEDERATION_SEARCH	Federation Search Interface	20080812

Properties

Class	CL_ESH_ADAPT_FS
Short Description	File 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	20080812	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_ADAPT_FS has no forward declaration.

Interfaces

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

Friends

Class CL_ESH_ADAPT_FS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ADAPTER_TYPE	Static Attribute	Private	☐	Type reference (TYPE)	STRING	'File Search'	Adapter type	20081124

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONVERT_FS_RESP_TO_ESH_RESP	Static method	Private	Method	Convert FS response data to ESH response	20080818
2	EXECUTE_F4_ATTR_SEARCH	Static method	Private	Method	Execute F4 search help	20090604
3	EXECUTE_SEARCH	Static method	Private	Method	Execute search	20080812
4	MAP_FILE_TYPE_TO_ICON	Static method	Private	Method	Map file type to icon	20091001
5	MAP_SRC_ESH_META_DATA_TO_FS	Static method	Private	Method	Convert ESH metadata of a connector to FS metadata	20080812
6	READ_FS_OBJ_TYPE_OF_CONNECTOR	Static method	Private	Method	Read the file search object type of the connector	20081120
7	SET_ERROR_IN_RESPONSE_BUILDER	Static method	Private	Method	Set error in response builder	20081223

Events

Class CL_ESH_ADAPT_FS has no event.

Types

Class CL_ESH_ADAPT_FS has no local type.

Method Signatures

Method CONVERT_FS_RESP_TO_ESH_RESP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_RESP_BUILDER	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_FED_GRP_RESP_BUILDER		Grouped Response Builder	20080818
2	Importing	IT_RESULT_ITEMS	Call by reference	☐	Type reference (TYPE)	SXES_T_RESULTS		Result table of one search service provider	20080818
3	Importing	IV_NO_OF_ALL_HITS	Call by reference	☐	Type reference (TYPE)	I			20080818
4	Importing	IV_NO_OF_HITS	Call by reference	☐	Type reference (TYPE)	I			20090126
5	Importing	IV_SEARCH_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20080818

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

Method EXECUTE_F4_ATTR_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULTS_FS	Call by reference	☐	Type reference (TYPE)	SXES_T_RESULTS		Result table of one search service provider	20090604
2	Importing	IR_REQUEST_DATA	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_FED_REQUEST_DATA		Search Request Data	20090604
3	Importing	IT_ESH_QUERY	Call by reference	☑	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20090615
4	Importing	IV_MAX_RESULTS	Call by reference	☐	Type reference (TYPE)	I		Maximum Results after F4 Search	20090604
5	Importing	IV_SEARCH_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20090604

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

Method EXECUTE_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ATTR_DIST_RANGES	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_DIST_RANGES		Attribute distribution ranges	20081217
2	Exporting	ET_ATTR_DIST_VALUES	Call by reference	☐	Type reference (TYPE)	TREXT_ATTR_DIST_VALUES		Attribute distribution values	20081217
3	Exporting	ET_RESULTS_FS	Call by reference	☐	Type reference (TYPE)	SXES_T_RESULTS		Search Responses	20080818
4	Exporting	ET_RETURN_CODES_FS	Call by reference	☐	Type reference (TYPE)	SESH_T_RETURN_CODES		Return codes per object type	20080818
5	Exporting	EV_NO_OF_ALL_HITS	Call by reference	☐	Type reference (TYPE)	I		Number of all hits	20090115
6	Exporting	EV_NO_OF_HITS	Call by reference	☐	Type reference (TYPE)	I		Number of hits	20090115
7	Importing	IS_ATTR_DIST_GLOBAL	Call by reference	☑	Type reference (TYPE)	SESH_S_ATTR_DIST_GLOBAL		Attribute distribution: Global settings	20090113
8	Importing	IT_ESH_QUERY	Call by reference	☐	Type reference (TYPE)	ESH_T_FED_QUERY_ENTRY		Query	20080812
9	Importing	IT_INT_NAVIGATION_ATTRS	Call by reference	☑	Type reference (TYPE)	ESH_T_IF_ATTR_NAMES		Table of Attribute Names	20081217
10	Importing	IT_OBJECT_TYPE_IDS	Call by reference	☐	Type reference (TYPE)	SXES_T_OBJECT_TYPE_IDS		Table with Object Types	20080818
11	Importing	IT_RESPONSE_ATTRIBUTE_TYPES	Call by reference	☑	Type reference (TYPE)	ESH_T_IF_MDATA_ATTRIBUTE_TYOBJ		Meta Data: Attribute Type Objects	20080812
12	Importing	IT_SORT_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	ESH_T_FED_SORT		Sort attributes	20081202
13	Importing	IV_FROM	Call by reference	☑	Type reference (TYPE)	I		From	20081202
14	Importing	IV_STATISTICAL_INFO	Call by reference	☑	Type reference (TYPE)	XFELD		'X' = Read Statistical Information	20090113
15	Importing	IV_TO	Call by reference	☑	Type reference (TYPE)	I		To	20081202

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

Method MAP_FILE_TYPE_TO_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILE_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20091001
2	Returning	RV_ICON	Value transfer	☐	Type reference (TYPE)	STRING			20091001

Method MAP_FILE_TYPE_TO_ICON on class CL_ESH_ADAPT_FS has no exception.

Method MAP_SRC_ESH_META_DATA_TO_FS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_REQUESTED_FIELDS	Call by reference	☐	Type reference (TYPE)	SXES_T_ATTR_NAMES		Table of attribute names	20080812
2	Importing	IT_RESPONSE_ATTRIBUTE_TYPES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_MDATA_ATTRIBUTE_TYOBJ		Meta Data: Attribute Type Objects	20080812

Method MAP_SRC_ESH_META_DATA_TO_FS on class CL_ESH_ADAPT_FS has no exception.

Method READ_FS_OBJ_TYPE_OF_CONNECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SEARCH_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20081120
2	Returning	RS_OBJECT_TYPE_ID	Value transfer	☐	Type reference (TYPE)	SXES_S_OBJECT_TYPE_ID		object type id	20081120

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADAPT_EXCEPTION	☐	Federated Search Exception	20090210

Method SET_ERROR_IN_RESPONSE_BUILDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_RESP_BUILDER	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_FED_GRP_RESP_BUILDER		Responses Builder	20081223
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20081223
3	Importing	IV_ERROR_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING		Error message	20081223

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

History

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