SAP ABAP Class CL_ESH_TOS_DOM_SEARCH_RESP_PRS (DOM Parser of Search Response URL)

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_DOM_SEARCH_RESP_PRS
Short Description	DOM Parser of Search Response URL
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_DOM_SEARCH_RESP_PRS has no forward declaration.

Interfaces

Class CL_ESH_TOS_DOM_SEARCH_RESP_PRS has no interface implemented.

Friends

Class CL_ESH_TOS_DOM_SEARCH_RESP_PRS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_NAMESPACE_OPENSEARCH	Constant	Private	☐	Type reference (TYPE)	STRING	'opensearch'		20100201
2	CO_NAMESPACE_SAP_ES	Constant	Private	☐	Type reference (TYPE)	STRING	'sap_es'		20100201
3	CO_TAG_ATTRIBUTE_DESCRIPTION	Constant	Private	☐	Type reference (TYPE)	STRING	'Description'		20100129
4	CO_TAG_ATTRIBUTE_IS_DEFAULT	Constant	Private	☐	Type reference (TYPE)	STRING	'IsDefault'		20100129
5	CO_TAG_ATTRIBUTE_SAP_ES_CONN	Constant	Private	☐	Type reference (TYPE)	STRING	'sap_es:connector'		20100129
6	CO_TAG_ATTRIBUTE_SAP_ES_ID	Constant	Private	☐	Type reference (TYPE)	STRING	'sap_es:id'		20100129
7	CO_TAG_ATTRIBUTE_SAP_ES_TYPE	Constant	Private	☐	Type reference (TYPE)	STRING	'sap_es:type'		20100129
8	CO_TAG_ATTRIBUTE_SEARCH_TERMS	Constant	Private	☐	Type reference (TYPE)	STRING	'searchTerms'		20100129
9	CO_TAG_ATTRIBUTE_TOTAL_RESULTS	Constant	Private	☐	Type reference (TYPE)	STRING	'totalResults'		20100129
10	CO_TAG_ATTRIBUTE_TYPE	Constant	Private	☐	Type reference (TYPE)	STRING	'Type'		20100129
11	CO_TAG_ATTR_SAP_ES_T_VAL_CONN	Constant	Private	☐	Type reference (TYPE)	STRING	'connector'		20100129
12	CO_TAG_NAME_CATEGORY	Constant	Private	☐	Type reference (TYPE)	STRING	'category'		20100129
13	CO_TAG_NAME_DESCRIPTION	Constant	Private	☐	Type reference (TYPE)	STRING	'description'		20100129
14	CO_TAG_NAME_ITEM	Constant	Private	☐	Type reference (TYPE)	STRING	'item'		20100129
15	CO_TAG_NAME_LINK	Constant	Private	☐	Type reference (TYPE)	STRING	'link'		20100129
16	CO_TAG_NAME_OPENSEARCH_QUERY	Constant	Private	☐	Type reference (TYPE)	STRING	'Query'		20100201
17	CO_TAG_NAME_OPENSEARCH_ST_IND	Constant	Private	☐	Type reference (TYPE)	STRING	'startIndex'		20100129
18	CO_TAG_NAME_OPENSEARCH_TOT_RES	Constant	Private	☐	Type reference (TYPE)	STRING	'totalResults'		20100129
19	CO_TAG_NAME_OPENS_I_PER_PAGE	Constant	Private	☐	Type reference (TYPE)	STRING	'itemsPerPage'		20100129
20	CO_TAG_NAME_ROLE	Constant	Private	☐	Type reference (TYPE)	STRING	'role'		20100129
21	CO_TAG_NAME_SAP_ES_ID	Constant	Private	☐	Type reference (TYPE)	STRING	'sap_es:ID'		20100129
22	CO_TAG_NAME_SAP_ES_LABEL_TEXT	Constant	Private	☐	Type reference (TYPE)	STRING	'sap_es:LabelText'		20100129
23	CO_TAG_NAME_SAP_ES_LINK	Constant	Private	☐	Type reference (TYPE)	STRING	'sap_es:Link'		20100129
24	CO_TAG_NAME_SAP_ES_S_OBJ_ATTR	Constant	Private	☐	Type reference (TYPE)	STRING	'sap_es:SearchObjectAttribute'		20100129
25	CO_TAG_NAME_SAP_VALUE_TEXT	Constant	Private	☐	Type reference (TYPE)	STRING	'sap_es:ValueText'		20100129
26	CO_TAG_NAME_TITLE	Constant	Private	☐	Type reference (TYPE)	STRING	'title'		20100129
27	CO_TAG_VALUE_SUBSET	Constant	Private	☐	Type reference (TYPE)	STRING	'subset'		20100129
28	CO_TYPE_VALUE_RELATED	Constant	Private	☐	Type reference (TYPE)	STRING	'related'		20100129
29	CO_TYPE_VALUE_TARGET	Constant	Private	☐	Type reference (TYPE)	STRING	'target'		20100129
30	LC_HTTP_CODE_200	Constant	Private	☐	Type reference (TYPE)	I	200		20100129
31	LC_HTTP_CODE_401	Constant	Private	☐	Type reference (TYPE)	I	401		20100129
32	LC_HTTP_CODE_404	Constant	Private	☐	Type reference (TYPE)	I	404		20100129
33	LC_HTTP_CODE_500	Constant	Private	☐	Type reference (TYPE)	I	500		20100129
34	LC_HTTP_CODE_510	Constant	Private	☐	Type reference (TYPE)	I	510		20100129
35	LC_NUMBER_129	Constant	Private	☐	Type reference (TYPE)	NUMC3	129		20100129
36	LC_NUMBER_130	Constant	Private	☐	Type reference (TYPE)	NUMC3	130		20100129
37	LC_NUMBER_131	Constant	Private	☐	Type reference (TYPE)	NUMC3	131		20100129
38	LC_NUMBER_132	Constant	Private	☐	Type reference (TYPE)	NUMC3	132		20100129
39	LC_NUMBER_133	Constant	Private	☐	Type reference (TYPE)	NUMC3	133		20100129
40	LC_NUMBER_134	Constant	Private	☐	Type reference (TYPE)	NUMC3	134		20100129
41	LC_NUMBER_135	Constant	Private	☐	Type reference (TYPE)	NUMC3	135		20100129
42	LC_NUMBER_136	Constant	Private	☐	Type reference (TYPE)	NUMC3	136		20100129
43	LC_NUMBER_137	Constant	Private	☐	Type reference (TYPE)	NUMC3	137		20100129
44	LC_NUMBER_138	Constant	Private	☐	Type reference (TYPE)	NUMC3	138		20100129
45	LC_NUMBER_139	Constant	Private	☐	Type reference (TYPE)	NUMC3	139		20100129
46	LC_NUMBER_140	Constant	Private	☐	Type reference (TYPE)	NUMC3	140		20100129
47	LC_NUMBER_141	Constant	Private	☐	Type reference (TYPE)	NUMC3	141		20100129
48	LC_NUMBER_142	Constant	Private	☐	Type reference (TYPE)	NUMC3	142		20100129
49	LC_NUMBER_144	Constant	Private	☐	Type reference (TYPE)	NUMC3	144		20100129
50	LC_NUMBER_145	Constant	Private	☐	Type reference (TYPE)	NUMC3	145		20100129
51	LC_NUMBER_207	Constant	Private	☐	Type reference (TYPE)	NUMC3	207		20100129
52	LC_NUMBER_244	Constant	Private	☐	Type reference (TYPE)	NUMC3	244		20100129
53	LC_NUMBER_245	Constant	Private	☐	Type reference (TYPE)	NUMC3	245		20100129
54	LO_SRC	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_SEARCH_SOURCE			20100129
55	LT_NAVIGATION_RESULTS	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_NAV_TARGET			20100129
56	LT_RELATED_SEARCH_SOURCES	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_REL_SEARCH_SOURCE			20100129
57	LT_RESULT_ENTRIES	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_SEARCH_RES			20100129
58	LT_RESULT_VALUES	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_SEARCH_ATTR			20100129
59	LT_SUB_SEARCH_ITEMS	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_SUB_SEARCH			20100129
60	LV_CONNECTOR_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
61	LV_COUNT	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
62	LV_DESCR_LOCAL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
63	LV_DESC_LOCAL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
64	LV_FLAG1	Instance attribute	Private	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE		20100129
65	LV_HTTP_CODE	Instance attribute	Private	☐	Type reference (TYPE)	I			20100129
66	LV_ID_LOCAL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
67	LV_LINK_LOCAL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
68	LV_NUM2	Instance attribute	Private	☐	Type reference (TYPE)	I			20100129
69	LV_NUMBER	Instance attribute	Private	☐	Type reference (TYPE)	NUMC3			20100129
70	LV_ORIGINAL_URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
71	LV_OS_ITEMS_PER_PAGE	Instance attribute	Private	☐	Type reference (TYPE)	STRING	'0'		20100129
72	LV_OS_START_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	STRING	'0'		20100129
73	LV_OS_TOTAL_RESULTS	Instance attribute	Private	☐	Type reference (TYPE)	STRING	'0'		20100129
74	LV_REASON	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
75	LV_START	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
76	LV_TITLE_LOCAL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129
77	LV_VALUE_LOCAL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100129

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor of the class	20100129
2	GET_OS_ITEMS_PER_PAGE	Instance method	Public	Method	Return OS items per page	20100129
3	GET_OS_START_INDEX	Instance method	Public	Method	Return OS start index	20100129
4	GET_OS_TOTAL_RESULTS	Instance method	Public	Method	Return OS total results	20100129
5	GET_RESULT_ENTRIES	Instance method	Public	Method	Return search result entries	20100129
6	GET_SUB_SEARCH_ITEMS	Instance method	Public	Method	Return subsearch items	20100129

Events

Class CL_ESH_TOS_DOM_SEARCH_RESP_PRS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	ES_S_STR	Public	See coding			20100129	BEGIN OF es_s_str , string_field TYPE string, END OF es_s_str
2	ES_T_STR_TABLE	Public	See coding			20100129	es_t_str_table TYPE STANDARD TABLE OF es_s_str
3	TY_NAV_TARGET	Public	See coding			20100129	BEGIN OF ty_nav_target , id_val type int4, nav_target TYPE REF TO CL_ESH_TOS_NAV_TARGET, END OF ty_nav_target
4	TY_REL_SEARCH_SOURCE	Public	See coding			20100129	BEGIN OF ty_rel_search_source , id_val type int4, rel_search_source TYPE REF TO CL_ESH_TOS_REL_SEARCH_SRC, END OF ty_rel_search_source
5	TY_SEARCH_ATTR	Public	See coding			20100129	BEGIN OF ty_search_attr , id_val type int4, search_attr TYPE REF TO CL_ESH_TOS_SEARCH_ATTR_VALUE, END OF ty_search_attr
6	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
7	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
8	TY_T_NAV_TARGET	Public	See coding			20100129	ty_t_nav_target TYPE STANDARD TABLE OF ty_nav_target with key id_val
9	TY_T_REL_SEARCH_SOURCE	Public	See coding			20100129	ty_t_rel_search_source TYPE STANDARD TABLE OF ty_rel_search_source with key id_val
10	TY_T_SEARCH_ATTR	Public	See coding			20100129	ty_t_search_attr TYPE STANDARD TABLE OF ty_search_attr with key id_val
11	TY_T_SEARCH_RES	Public	See coding			20100129	ty_t_search_res TYPE STANDARD TABLE OF ty_search_result with key id_val
12	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_SOURCE1	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_TOS_SEARCH_SOURCE			20100201
2	Importing	IV_COUNT1	Call by reference	☐	Type reference (TYPE)	STRING			20100201
3	Importing	IV_HTTP_DESTINATION1	Call by reference	☐	Type reference (TYPE)	RFCDEST			20100201
4	Importing	IV_LANGUAGE1	Call by reference	☐	Type reference (TYPE)	STRING			20100201
5	Importing	IV_QUERY_URL1	Call by reference	☐	Type reference (TYPE)	STRING			20100201
6	Importing	IV_START1	Call by reference	☐	Type reference (TYPE)	STRING			20100201
7	Importing	IV_TEMPLATE_URL1	Call by reference	☐	Type reference (TYPE)	STRING			20100201

Method CONSTRUCTOR on class CL_ESH_TOS_DOM_SEARCH_RESP_PRS 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	EV_OS_ITEMS_PER_PAGE	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_OS_ITEMS_PER_PAGE on class CL_ESH_TOS_DOM_SEARCH_RESP_PRS 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	EV_OS_START_INDEX	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_OS_START_INDEX on class CL_ESH_TOS_DOM_SEARCH_RESP_PRS 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	EV_TOTAL_RESULTS	Value transfer	☐	Type reference (TYPE)	STRING			20100129

Method GET_OS_TOTAL_RESULTS on class CL_ESH_TOS_DOM_SEARCH_RESP_PRS has no exception.

Method GET_RESULT_ENTRIES Signature

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

Method GET_RESULT_ENTRIES on class CL_ESH_TOS_DOM_SEARCH_RESP_PRS has no exception.

Method GET_SUB_SEARCH_ITEMS Signature

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

Method GET_SUB_SEARCH_ITEMS on class CL_ESH_TOS_DOM_SEARCH_RESP_PRS has no exception.

History

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