SAP ABAP Class CL_ESH_OS_DESCRIPTION_BUILDER (OS Description Builder)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_IF_OPEN_SEARCH (Package) Open Search Service

Properties

Class	CL_ESH_OS_DESCRIPTION_BUILDER
Short Description	OS Description Builder
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_IF_OPEN_SEARCH	Open Search Service
Created	20081021	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_ABAP_CHAR_UTILITIES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	IF_ESH_SE_RUNTIME_DATA	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_ESH_OS_DESCRIPTION_BUILDER has no interface implemented.

Friends

Class CL_ESH_OS_DESCRIPTION_BUILDER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CV_LF	Constant	Public	☐	Type reference (TYPE)	CHAR2	CL_ABAP_CHAR_UTILITIES=>CR_LF	Version number component	20081021
2	MR_DOM	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20081211
3	MR_IXML	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML		IF_IXML	20081211
4	MT_REQ_ATTR_BACKEND_NAMES	Instance attribute	Private	☐	Type reference (TYPE)	T_REQ_ATTR_BACKEND_NAMES			20090317
5	MT_RES_ATTR_BACKEND_NAMES	Instance attribute	Private	☐	Type reference (TYPE)	T_RES_ATTR_BACKEND_NAMES			20090317
6	MV_CATEGORY_ID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_IF_CATEGORY_ID		Category ID	20081023
7	MV_COMPATIBILITY_MODE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20090120
8	MV_CONNECTOR_ID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search connector ID	20081023
9	MV_NAMESPACE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20090120
10	MV_NS_PREFIX	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20090120
11	MV_REQUEST_TYPE_ID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request type ID	20081104
12	MV_TEMPLATE_ID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_IF_TEMPLATE_ID		Search connector template ID	20081104

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CATEGORY_METADATA	Instance method	Private	Method	Add category metadata information	20100210
2	ADD_CONNECTOR_METADATA	Instance method	Private	Method	Add connector metadata information	20100210
3	ADD_ICON	Instance method	Private	Method	Add icon	20090226
4	ADD_SCOPE_DESCRIPTIONS	Instance method	Private	Method	Get scope description	20081212
5	ADD_URL_TEMPLATE	Instance method	Private	Method	Get OpenSearch URL template	20081212
6	APPEND_ATTRIBUTE	Instance method	Private	Method	Append the attribute information	20081212
7	APPEND_CATEGORY	Instance method	Private	Method	Append the categories	20081212
8	APPEND_CONNECTIVITY	Instance method	Private	Method	Append the connectivity	20081212
9	APPEND_CONNECTOR_REQUEST	Instance method	Private	Method	Append the connector request	20081212
10	APPEND_NAMES	Instance method	Private	Method	Append names	20081212
11	APPEND_RELATED_REQUESTS	Instance method	Private	Method	Append the related requests	20090618
12	APPEND_REQUEST	Instance method	Private	Method	Append request information	20081212
13	APPEND_RESPONSE	Instance method	Private	Method	Append response information	20081212
14	APPEND_TEMPLATE	Instance method	Private	Method	Append template information	20081212
15	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20081023
16	FILL_BACKENDNAME_TABLES	Instance method	Private	Method	Fill class instance tables for back-end names	20090317
17	GET_ALL_CONTENT_NAMES	Instance method	Private	Method	Get multilingual names of All Content category	20101105
18	GET_CATEGORIES	Instance method	Private	Method	Append template information	20081212
19	GET_DESCRIPTION	Instance method	Public	Method	Get OpenSearch description document	20081021

Events

Class CL_ESH_OS_DESCRIPTION_BUILDER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_REQ_ATTR_BACKEND_NAMES	Public	See coding			20090317	BEGIN OF s_req_attr_backend_names, request_id TYPE esh_e_if_con_request_type_id, field_id TYPE char32, backend_name TYPE esh_e_om_backend_name, END OF s_req_attr_backend_names
2	S_RES_ATTR_BACKEND_NAMES	Public	See coding			20090317	BEGIN OF s_res_attr_backend_names, field_id TYPE char32, backend_name TYPE esh_e_om_backend_name, END OF s_res_attr_backend_names
3	T_REQ_ATTR_BACKEND_NAMES	Public	See coding			20090317	t_req_attr_backend_names TYPE STANDARD TABLE OF s_req_attr_backend_names
4	T_RES_ATTR_BACKEND_NAMES	Public	See coding			20090317	t_res_attr_backend_names TYPE STANDARD TABLE OF s_res_attr_backend_names

Method Signatures

Method ADD_CATEGORY_METADATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20100210

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20100210

Method ADD_CONNECTOR_METADATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20100210

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20100210

Method ADD_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20090226

Method ADD_ICON on class CL_ESH_OS_DESCRIPTION_BUILDER has no exception.

Method ADD_SCOPE_DESCRIPTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20090115

Method ADD_URL_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212
2	Importing	IV_REQUEST_ATTRIBUTE	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_ATTRIBUTE_NAME		Attribute Name	20100223
3	Importing	IV_RESPONSE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OS_RESPONSE_TYPE		Open Search response type	20081212

Method ADD_URL_TEMPLATE on class CL_ESH_OS_DESCRIPTION_BUILDER has no exception.

Method APPEND_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212
2	Importing	IS_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_ATTRIBUTE_TYPE_SORTED			20081212
3	Importing	IT_COMMON_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_COMMON_ATTRIBUTES_SORTED			20100212
4	Importing	I_REQUEST_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_CON_REQUEST_TYPE_ID		Request Type ID	20090317

Method APPEND_ATTRIBUTE on class CL_ESH_OS_DESCRIPTION_BUILDER has no exception.

Method APPEND_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212
2	Importing	IT_CATEGORIES	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_CATEGORIES_SORTED		Node Name	20081212

Method APPEND_CATEGORY on class CL_ESH_OS_DESCRIPTION_BUILDER has no exception.

Method APPEND_CONNECTIVITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212
2	Importing	I_CONNECTION_GUID	Call by reference	☐	Type reference (TYPE)	ESH_E_ADM_CONNECTION_GUID		Connection GUID	20081212

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20090115

Method APPEND_CONNECTOR_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212
2	Importing	IS_CONNECTOR	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED		Connector (sorted)	20081212
3	Importing	IV_REQUEST_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request Type ID	20081212

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20090115

Method APPEND_NAMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DEFAULT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081212
2	Importing	IP_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212
3	Importing	IT_NAMES	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_LANGU_NAMES_SORTED		Language dependent names (sorted)	20081212

Method APPEND_NAMES on class CL_ESH_OS_DESCRIPTION_BUILDER has no exception.

Method APPEND_RELATED_REQUESTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20090618
2	Importing	IT_RELATED_REQUESTS	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_RELATED_CONNECTORS_SORTED		Related Requests	20090618

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20090618

Method APPEND_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DEFAULT_REQUEST_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081212
2	Importing	IP_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212
3	Importing	IT_REQUESTS	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_REQUEST_TYPES_SORTED			20081212
4	Importing	I_DEFAULT_REQUEST	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_CON_REQUEST_TYPE_ID		Request Type ID	20081212
5	Importing	I_REQUEST	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_CON_REQUEST_TYPE_ID		Request Type ID	20081212

Method APPEND_REQUEST on class CL_ESH_OS_DESCRIPTION_BUILDER has no exception.

Method APPEND_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212
2	Importing	IT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_ATTRIBUTE_TYPES_SORTED			20081212

Method APPEND_RESPONSE on class CL_ESH_OS_DESCRIPTION_BUILDER has no exception.

Method APPEND_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CATEGORIES	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_CATEGORIES_SORTED		Categories (sorted)	20081212
2	Importing	IP_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081212
3	Importing	I_CONNECTION_GUID	Call by reference	☐	Type reference (TYPE)	ESH_E_ADM_CONNECTION_GUID		Connection GUID	20081212
4	Importing	I_NODE_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20081212
5	Importing	I_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20081212

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20090115

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CATEGORY	Call by reference	☑	Type reference (TYPE)	STRING			20081104
2	Importing	IV_COMPATIBILITY_MODE	Call by reference	☑	Type reference (TYPE)	STRING			20090120
3	Importing	IV_CONNECTOR	Call by reference	☑	Type reference (TYPE)	STRING			20081104
4	Importing	IV_REQUEST	Call by reference	☑	Type reference (TYPE)	STRING			20081104
5	Importing	IV_TEMPLATE	Call by reference	☑	Type reference (TYPE)	STRING			20081104

Method CONSTRUCTOR on class CL_ESH_OS_DESCRIPTION_BUILDER has no exception.

Method FILL_BACKENDNAME_TABLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONNECTOR	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED		Connector (sorted)	20090317

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_INVALID_PARAMETER	☐	Invalid Parameter	20090317
2	CX_ESH_CO_NOT_FOUND	☐	Requested Data not Found	20090317

Method GET_ALL_CONTENT_NAMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_NAMES	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_LANGU_NAMES_SORTED		Table for language dependent names (sorted)	20101105

Method GET_ALL_CONTENT_NAMES on class CL_ESH_OS_DESCRIPTION_BUILDER has no exception.

Method GET_CATEGORIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CATEGORIES	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_CATEGORIES_SORTED		Categories (sorted)	20081212
2	Importing	IS_CONNECTOR	Call by reference	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED		Connector (sorted)	20081212

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20090115

Method GET_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RV_RESULT	Call by reference	☐	Type reference (TYPE)	STRING			20081021
2	Exporting	RV_XRESULT	Call by reference	☐	Type reference (TYPE)	XSTRING			20100118

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20090115

History

Last changed by/on	SAP	20130531
SAP Release Created in	720