SAP ABAP Class CL_ESH_TOS_SEARCH_RESPONSE (Represents the Search Response)

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)

Properties

Class	CL_ESH_TOS_SEARCH_RESPONSE
Short Description	Represents the Search Response
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_RESPONSE has no forward declaration.

Interfaces

Class CL_ESH_TOS_SEARCH_RESPONSE has no interface implemented.

Friends

Class CL_ESH_TOS_SEARCH_RESPONSE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_INCLUDE_ATTRIBUTES_1	Constant	Private	☐	Type reference (TYPE)	STRING	'&include_attributes=1'		20100129
2	CO_INCLUDE_ATTRIBUTES_2	Constant	Private	☐	Type reference (TYPE)	STRING	'?include_attributes=1'		20100129
3	CO_SAP_LANGUAGE_1	Constant	Private	☐	Type reference (TYPE)	STRING	'&sap-language='		20100201
4	LO_SRC	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_SEARCH_SOURCE			20100129
5	LT_RESULT_ENTRIES	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_SEARCH_RES			20100129
6	LT_SUB_SEARCH_ITEMS	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_SUB_SEARCH			20100129
7	LV_HTTP_DESTINATION	Instance attribute	Private	☐	Type reference (TYPE)	RFCDEST			20100129
8	LV_LANGUAGE	Instance attribute	Private	☐	Type reference (TYPE)	STRING	'EN'		20100201
9	LV_OS_ITEMS_PER_PAGE	Instance attribute	Private	☐	Type reference (TYPE)	STRING	'0'		20100129
10	LV_OS_START_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	STRING	'0'		20100129
11	LV_OS_TOTAL_RESULTS	Instance attribute	Private	☐	Type reference (TYPE)	STRING	'0'		20100129
12	LV_QUERY_URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100201
13	LV_TEMPLATE_URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100201

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20100129
2	GET_DISTINCT_CONNECTOR_IDS	Instance method	Public	Method	Return unique connector IDs	20100129
3	GET_OS_ITEMS_PER_PAGE	Instance method	Public	Method	Return OS items per page	20100129
4	GET_OS_START_INDEX	Instance method	Public	Method	Return OS start index	20100129
5	GET_OS_TOTAL_RESULTS	Instance method	Public	Method	Return OS total results	20100129
6	GET_RESULTS	Instance method	Public	Method	Return the results	20100129
7	GET_SEARCH_SOURCE	Instance method	Public	Method	Return the search source	20100129
8	GET_SUB_SEARCH_ITEMS	Instance method	Public	Method	Return subsearch items	20100129

Events

Class CL_ESH_TOS_SEARCH_RESPONSE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_SEARCH_RESULT	Public	See coding			20100129	BEGIN OF ty_search_result , id_val type int4, search_result TYPE REF TO CL_ESH_TOS_SEARCH_RESULT, END OF ty_search_result
2	TY_SUB_SEARCH	Public	See coding			20100129	BEGIN OF ty_sub_search , id_val type int4, sub_search TYPE REF TO CL_ESH_TOS_SUB_SEARCH, END OF ty_sub_search
3	TY_S_CONNECTOR_ID	Public	See coding			20100208	begin of ty_s_connector_id, connector_id type string, end of ty_s_connector_id
4	TY_T_CONNECTOR_ID	Public	See coding			20100208	ty_t_connector_id type sorted table of ty_s_connector_id with UNIQUE key connector_id
5	TY_T_SEARCH_RES	Public	See coding			20100129	ty_t_search_res TYPE STANDARD TABLE OF ty_search_result with key id_val
6	TY_T_SUB_SEARCH	Public	See coding			20100129	ty_t_sub_search TYPE STANDARD TABLE OF ty_sub_Search 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_SOURCE	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_SEARCH_SOURCE			20100129
2	Importing	IV_COUNT	Call by reference	☐	Type reference (TYPE)	STRING			20100129
3	Importing	IV_HTTP_DESTINATION1	Call by reference	☐	Type reference (TYPE)	RFCDEST			20100201
4	Importing	IV_QUERYURL	Call by reference	☐	Type reference (TYPE)	STRING			20100129
5	Importing	IV_START	Call by reference	☐	Type reference (TYPE)	STRING			20100129
6	Importing	IV_TEMPLATE_URL	Call by reference	☐	Type reference (TYPE)	STRING			20100129

Method CONSTRUCTOR on class CL_ESH_TOS_SEARCH_RESPONSE has no exception.

Method GET_DISTINCT_CONNECTOR_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DISTINCT_ID	Call by reference	☐	Type reference (TYPE)	TY_T_CONNECTOR_ID			20100202

Method GET_DISTINCT_CONNECTOR_IDS on class CL_ESH_TOS_SEARCH_RESPONSE has no exception.

Method GET_OS_ITEMS_PER_PAGE Signature

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

Method GET_OS_ITEMS_PER_PAGE on class CL_ESH_TOS_SEARCH_RESPONSE has no exception.

Method GET_OS_START_INDEX Signature

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

Method GET_OS_START_INDEX on class CL_ESH_TOS_SEARCH_RESPONSE has no exception.

Method GET_OS_TOTAL_RESULTS Signature

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

Method GET_OS_TOTAL_RESULTS on class CL_ESH_TOS_SEARCH_RESPONSE has no exception.

Method GET_RESULTS Signature

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

Method GET_RESULTS on class CL_ESH_TOS_SEARCH_RESPONSE has no exception.

Method GET_SEARCH_SOURCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_SRC	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_SEARCH_SOURCE			20100129

Method GET_SEARCH_SOURCE on class CL_ESH_TOS_SEARCH_RESPONSE has no exception.

Method GET_SUB_SEARCH_ITEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_SUB_SEARCH_ITEMS	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_SUB_SEARCH_ITER			20100129

Method GET_SUB_SEARCH_ITEMS on class CL_ESH_TOS_SEARCH_RESPONSE has no exception.

History

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