SAP ABAP Class CL_ESH_TOS_SEARCH_SOURCE (Search Source)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_TST_AUT_OPEN_SEARCH_CLNT (Package) Open Search Client (ABAP)

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_ESH_TOS_CATEG_SEARCH_SRC	Represents category search source	20100129
2	Inheritance (c INHERITING FROM c_ref)	CL_ESH_TOS_DEFAULT_SEARCH_SRC	Represents default search source	20100129
3	Inheritance (c INHERITING FROM c_ref)	CL_ESH_TOS_REQ_SEARCH_SRC	Represents request search source	20100129

Properties

Class	CL_ESH_TOS_SEARCH_SOURCE
Short Description	Search Source
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_TST_AUT_OPEN_SEARCH_CLNT	Open Search Client (ABAP)
Created	20100129	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_TOS_SEARCH_SOURCE has no forward declaration.

Interfaces

Class CL_ESH_TOS_SEARCH_SOURCE has no interface implemented.

Friends

Class CL_ESH_TOS_SEARCH_SOURCE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_COUNT	Constant	Private	☐	Type reference (TYPE)	STRING	'{count?}'		20100129
2	CO_SAP_LANGUAGE_1	Constant	Private	☐	Type reference (TYPE)	STRING	'&sap-language='		20100129
3	CO_SAP_LANGUAGE_2	Constant	Private	☐	Type reference (TYPE)	STRING	'?sap-language='		20100129
4	CO_SEARCH_TERMS	Constant	Private	☐	Type reference (TYPE)	STRING	'{searchTerms}'		20100129
5	CO_START_INDEX	Constant	Private	☐	Type reference (TYPE)	STRING	'{startIndex?}'		20100129
6	LO_HTTP_DESTINATION	Instance attribute	Private	☐	Type reference (TYPE)	RFCDEST			20100129
7	LT_REQUEST_ATTR	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_ATTR_TABLE			20100129
8	LT_RESPONSE_ATTR	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_ATTR_TABLE			20100129
9	LV_CONNECTOR_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
10	LV_DESCRIPTION	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
11	LV_DESCRIPTION_URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
12	LV_IMAGE_HEIGHT	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
13	LV_IMAGE_URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
14	LV_IMAGE_WIDTH	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
15	LV_IS_ACTIVE_SEARCH_SOURCE	Instance attribute	Private	☐	Type reference (TYPE)	BOOLEAN	ABAP_TRUE		20100129
16	LV_IS_DEFAULT_REQUEST	Instance attribute	Private	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE		20100129
17	LV_ITEM_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
18	LV_LANGUAGE	Instance attribute	Private	☐	Type reference (TYPE)	STRING	'EN'		20100201
19	LV_OPERATION_STATUS_CODE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
20	LV_OPERATION_STATUS_TEXT	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
21	LV_PARSED	Instance attribute	Private	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE		20100129
22	LV_REQUEST_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
23	LV_URL_LINK	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor		20100129
2	GET_CONNECTOR_ID	Instance method	Public	Method		20100129
3	GET_DESCRIPTION	Instance method	Public	Method		20100129
4	GET_ID	Instance method	Public	Method		20100129
5	GET_IMAGE_HEIGHT	Instance method	Public	Method		20100129
6	GET_IMAGE_URL	Instance method	Public	Method		20100129
7	GET_IMAGE_WIDTH	Instance method	Public	Method		20100129
8	GET_OPERATION_STATUS_CODE	Instance method	Public	Method		20100129
9	GET_OPERATION_STATUS_TEXT	Instance method	Public	Method		20100129
10	GET_PARSED	Instance method	Protected	Method		20100129
11	GET_REQUEST_ID	Instance method	Public	Method		20100129
12	GET_REQ_ATTR	Instance method	Protected	Method		20100129
13	GET_RESPONSE	Instance method	Public	Method		20100129
14	GET_RESPONSE_BY_QUERY	Instance method	Public	Method		20100129
15	GET_RESP_ATTR	Instance method	Protected	Method		20100129
16	IS_ACTIVE_SEARCH_SOURCE	Instance method	Public	Method		20100129
17	IS_DEFAULT_REQ	Instance method	Protected	Method		20100129
18	PARSE_AND_STORE	Instance method	Public	Method		20100129

Events

Class CL_ESH_TOS_SEARCH_SOURCE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_ATTR	Public	See coding			20100129	BEGIN OF ty_attr , id_val type int4, search_attribute TYPE REF TO CL_ESH_TOS_SEARCH_ATTR, END OF ty_attr
2	TY_T_ATTR_TABLE	Public	See coding			20100129	ty_t_attr_table TYPE STANDARD TABLE OF ty_attr with key id_val

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HTTP_DESTINATION	Call by reference	☐	Type reference (TYPE)	RFCDEST			20100129
2	Importing	IO_LIST_ENTRY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_LIST_ENTRY			20100129

Method CONSTRUCTOR on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_CONNECTOR_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CONNECTOR_ID	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_CONNECTOR_ID on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_DESCRIPTION	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_DESCRIPTION on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ID	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_ID on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_IMAGE_HEIGHT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IMAGE_HEIGHT	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_IMAGE_HEIGHT on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_IMAGE_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IMAGE_URL	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_IMAGE_URL on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_IMAGE_WIDTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IMAGE_WIDTH	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_IMAGE_WIDTH on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_OPERATION_STATUS_CODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_OPERATION_STATUS_CODE	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_OPERATION_STATUS_CODE on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_OPERATION_STATUS_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_OPERATION_STATUS_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_OPERATION_STATUS_TEXT on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_PARSED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_PARSED	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_PARSED on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_REQUEST_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_REQUEST_ID	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_REQUEST_ID on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_REQ_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_REQ_ATTR	Call by reference	☐	Type reference (TYPE)	TY_T_ATTR_TABLE			20100129

Method GET_REQ_ATTR on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_SEARCH_RESPONSE1	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_SEARCH_RESPONSE			20100129
2	Importing	IV_COUNT1	Call by reference	☐	Type reference (TYPE)	STRING			20100129
3	Importing	IV_FROM1	Call by reference	☐	Type reference (TYPE)	STRING			20100129
4	Importing	IV_TERMS	Call by reference	☐	Type reference (TYPE)	STRING			20100129

Method GET_RESPONSE on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_RESPONSE_BY_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_SEARCH_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_SEARCH_RESPONSE			20100129
2	Importing	IV_COUNT	Call by reference	☐	Type reference (TYPE)	STRING			20100129
3	Importing	IV_FROM	Call by reference	☐	Type reference (TYPE)	STRING			20100129
4	Importing	IV_QUERY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_SEARCH_QUERY			20100129

Method GET_RESPONSE_BY_QUERY on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method GET_RESP_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESP_ATTR	Call by reference	☐	Type reference (TYPE)	TY_T_ATTR_TABLE			20100129

Method GET_RESP_ATTR on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method IS_ACTIVE_SEARCH_SOURCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IS_ACTIVE_SEARCH_SOURCE	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method IS_ACTIVE_SEARCH_SOURCE on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method IS_DEFAULT_REQ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IS_DEFAULT_REQUEST	Value transfer	☐	Type reference (TYPE)	BOOLEAN			20100129

Method IS_DEFAULT_REQ on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

Method PARSE_AND_STORE Signature

Method PARSE_AND_STORE on class CL_ESH_TOS_SEARCH_SOURCE has no parameter.
Method PARSE_AND_STORE on class CL_ESH_TOS_SEARCH_SOURCE has no exception.

History

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