SAP ABAP Class CL_ESH_OS_LIST_BUILDER (OPML List 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_LIST_BUILDER
Short Description	OPML List 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	20081023	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CL_ABAP_CHAR_UTILITIES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_ESH_OS_LIST_BUILDER has no interface implemented.

Friends

Class CL_ESH_OS_LIST_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	20081023
2	CV_TYPE_ALL	Constant	Public	☐	Type reference (TYPE)	STRING	'all'	Type: All	20081029
3	CV_TYPE_CATEGORY	Constant	Public	☐	Type reference (TYPE)	STRING	'category'	Type: Category	20081023
4	CV_TYPE_CONNECTOR	Constant	Public	☐	Type reference (TYPE)	STRING	'connector'	Type: Connector	20081023
5	CV_TYPE_HIERARCHY	Constant	Public	☐	Type reference (TYPE)	STRING	'hierarchy'	Type: Hierarchy	20100209
6	CV_TYPE_REQUEST	Constant	Public	☐	Type reference (TYPE)	STRING	'request'	Type: Connector request	20090217
7	MR_DOM	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20081209
8	MR_IXML	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML		IF_IXML	20081210
9	MV_COMPATIBILITY_MODE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Compatibility mode	20090120
10	MV_INCLUDE_INACTIVE_SERVICES	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Include inactive services	20090107
11	MV_NAMESPACE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Namespace	20090120
12	MV_NS_PREFIX	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Namespace prefix	20090120

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CHILDREN	Instance method	Private	Method	Add children to scope in hierarchy	20100209
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20081209
3	GET_ENTRY	Instance method	Private	Method	Get OPML entry	20081023
4	GET_HEADER	Instance method	Private	Method	Get OPML header	20081023
5	GET_LIST	Instance method	Public	Method	Get OPML list of OpenSearch description services	20081023

Events

Class CL_ESH_OS_LIST_BUILDER has no event.

Types

Class CL_ESH_OS_LIST_BUILDER has no local type.

Method Signatures

Method ADD_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_ENTRY	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20100209
2	Importing	IV_CATEGORY	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_CATEGORY_ID		Category ID	20100209

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

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPATIBILITY_MODE	Call by reference	☑	Type reference (TYPE)	STRING			20090120
2	Importing	IV_INCLUDE_INACTIVE_SERVICES	Call by reference	☑	Type reference (TYPE)	STRING			20090107

Method CONSTRUCTOR on class CL_ESH_OS_LIST_BUILDER has no exception.

Method GET_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CATEGORY_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_CATEGORY_ID		Category ID	20081023
2	Importing	IV_CONNECTOR_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20081023
3	Importing	IV_REQUEST_TYPE_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_REQUEST_TYPE_ID		Request Type ID	20090217
4	Exporting	RR_ENTRY	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081210

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

Method GET_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RR_BODY	Value transfer	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_ELEMENT	20081209

Method GET_HEADER on class CL_ESH_OS_LIST_BUILDER has no exception.

Method GET_LIST 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			20081023
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	20090113

History

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