SAP ABAP Class CL_ESH_IF_BOS_DP_CONTROLLER (Data Provider Controller)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_ADMIN_BOS (Package) Monitoring and Admin for the BOS Component

Properties

Class	CL_ESH_IF_BOS_DP_CONTROLLER
Short Description	Data Provider Controller
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_ADMIN_BOS	Monitoring and Admin for the BOS Component
Created	20070305	SAP
Last change	20110908	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)

Interfaces

Class CL_ESH_IF_BOS_DP_CONTROLLER has no interface implemented.

Friends

Class CL_ESH_IF_BOS_DP_CONTROLLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_CONNECTOR_INTERFACE	Constant	Private	☐	Type reference (TYPE)	SEOCLSNAME	'IF_ESH_IF_BOS_DP_CONNECTOR'	Interface of all connector implementations	20070312
2	GC_DATA_PROVIDER_LONGTEXT	Constant	Public	☐	Type reference (TYPE)	ESH_E_OM_DATA_PROVIDER	'ESH_S_LTXT_EXTRACTION_CLIENT'	Data provider for long text	20080728
3	GC_DEFAULT_PACKAGE_SIZE	Constant	Private	☐	Type reference (TYPE)	I	10000	Default package size for iterator	20070312
4	GC_TDNAME	Constant	Public	☐	Type reference (TYPE)	FIELDNAME	'TDNAME'	Field name 'TDNAME'	20080728
5	GR_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_IF_BOS_DP_CONTROLLER		Data provider controller	20070305
6	GT_CONNECTOR_REGISTRY	Static Attribute	Private	☐	Type reference (TYPE)	LTY_T_CONNECTOR_REGISTRY_TYPE		Registry for connector implementations	20070312

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_CONNECTOR_REGISTRY	Instance method	Private	Method	Build the connector registry	20070312
2	CONSTRUCTOR	Instance method	Private	Constructor	Private constructor	20070305
3	CREATE_DATA_STRUCTURE	Static method	Public	Method	Create a dynamic data structure for the specified fields	20070306
4	EXTRACT_NODE_DATA	Instance method	Public	Method	Extract node data via the specified technology	20070305
5	GET_DATA_SOURCE_INFO	Instance method	Public	Method	Get information about the data source	20070312
6	GET_DP_DATA_ITERATOR	Instance method	Public	Method	Get a data iterator for the data of the specified datasource	20070307
7	GET_INSTANCE	Static method	Public	Method	Get instance method for singleton instance	20070305
8	PREPARE_NODE	Instance method	Public	Method	Prepare the specified node	20070622

Events

Class CL_ESH_IF_BOS_DP_CONTROLLER has no event.

Types

Class CL_ESH_IF_BOS_DP_CONTROLLER has no local type.

Method Signatures

Method BUILD_CONNECTOR_REGISTRY Signature

Method BUILD_CONNECTOR_REGISTRY on class CL_ESH_IF_BOS_DP_CONTROLLER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_CLASS_NOT_EXISTENT	☐	Class Does Not Exist	20070312

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_ESH_IF_BOS_DP_CONTROLLER has no parameter.
Method CONSTRUCTOR on class CL_ESH_IF_BOS_DP_CONTROLLER has no exception.

Method CREATE_DATA_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_DATA_STRUCTURE_REF	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Reference to dynamic data structure	20070306
2	Exporting	ER_DATA_TABLE_REF	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Reference to dynamic data table	20070306
3	Importing	IT_FIELDS	Call by reference	☐	Type reference (TYPE)	DDFIELDS		DD: Field List	20070306
4	Importing	IV_INCL_DATA_TABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Flag: Create a dynamic data table	20070306
5	Importing	IV_KEY_FIELDS_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Flag: Consider key fields only	20070306

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20080218
2	CX_SY_CREATE_DATA_ERROR	☐	System-Exception Creating Data	20070306
3	CX_SY_STRUCT_CREATION	☐	Exception when Creating a Structure Type	20070306
4	CX_SY_TABLE_CREATION	☐	Exception when Creating a Table Type	20070306

Method EXTRACT_NODE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LOG_MESSAGES	Call by reference	☐	Type reference (TYPE)	ESH_T_ADM_BAL_S_MSG		Messages for application log	20070305
2	Exporting	EV_CLEAR_INDEX	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Flag: clear index	20090618
3	Exporting	EV_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Flag: Error occured	20070305
4	Importing	IV_CONNECTION_GUID	Call by reference	☐	Type reference (TYPE)	ESH_E_ADM_CONNECTION_GUID		Connection GUID	20071123
5	Importing	IV_LOGSYS	Call by reference	☐	Type reference (TYPE)	LOGSYS		Logical system	20070305
6	Importing	IV_MODE	Call by reference	☐	Type reference (TYPE)	ESH_E_IX_INITIAL_DELTA_LOAD		Mode for indexing data: Initial load or delta load	20070305
7	Importing	IV_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20070305
8	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20070305

Method EXTRACT_NODE_DATA on class CL_ESH_IF_BOS_DP_CONTROLLER has no exception.

Method GET_DATA_SOURCE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LOG_MESSAGES	Call by reference	☐	Type reference (TYPE)	ESH_T_ADM_BAL_S_MSG		Messages for application log	20070312
2	Exporting	ET_NODE_FIELDS	Call by reference	☐	Type reference (TYPE)	ESH_T_OM_AOTYPNF_EXT		Fields of a node	20070312
3	Exporting	ET_NODE_FILTER	Call by reference	☐	Type reference (TYPE)	ESH_T_OM_ADPRVDFLC_EXT		Filter conditions	20070704
4	Exporting	EV_CROSS_CLIENT	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_CROSS_CLIENT		Flag: Object is cross Client	20070402
5	Exporting	EV_DATA_SOURCE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_DATA_SOURCE_NAME		Data Source Name	20070312
6	Exporting	EV_DATA_SOURCE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_DATA_SOURCE_TYPE		Data Source Type	20070312
7	Exporting	EV_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Flag: Error occured	20070312
8	Exporting	EV_EXTR_TECHNOLOGY	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_DATA_SOURCE_TECHN		Technology of Data Source	20070312
9	Exporting	EV_LONGTEXT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Flag: Node has longtext	20080728
10	Exporting	EV_LONGTEXT_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name of longtext node	20080728
11	Exporting	EV_TEXT_OBJECT	Call by reference	☐	Type reference (TYPE)	TDOBJECT		Texts: application object	20080728
12	Importing	IV_CHECK_LONGTEXT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Flag: Check for longtext	20080728
13	Importing	IV_CONNECTION_GUID	Call by reference	☐	Type reference (TYPE)	ESH_E_ADM_CONNECTION_GUID		Connection GUID	20071123
14	Importing	IV_LOGSYS	Call by reference	☐	Type reference (TYPE)	LOGSYS		Logical system	20070312
15	Importing	IV_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20070312
16	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20070312

Method GET_DATA_SOURCE_INFO on class CL_ESH_IF_BOS_DP_CONTROLLER has no exception.

Method GET_DP_DATA_ITERATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_DATA_ITERATOR	Call by reference	☐	Object reference (TYPE REF TO)	IF_ESH_IF_BOS_DATA_ITERATOR		Iterator for data packages	20070312
2	Exporting	ET_LOG_MESSAGES	Call by reference	☐	Type reference (TYPE)	ESH_T_ADM_BAL_S_MSG		Messages for application log	20070312
3	Exporting	ET_NODE_FIELDS	Call by reference	☐	Type reference (TYPE)	ESH_T_OM_AOTYPNF_EXT		Table Type for ESH_S_OM_AOTYPN_EXT	20081204
4	Exporting	EV_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Flag: Error occured	20070312
5	Exporting	EV_LONGTEXT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Flag: Node has longtext	20080728
6	Exporting	EV_LONGTEXT_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name of longtext node	20080728
7	Exporting	EV_TEXT_OBJECT	Call by reference	☐	Type reference (TYPE)	TDOBJECT		Texts: application object	20080728
8	Importing	IV_CONNECTION_GUID	Call by reference	☐	Type reference (TYPE)	ESH_E_ADM_CONNECTION_GUID		Connection GUID	20071123
9	Importing	IV_LOGSYS	Call by reference	☐	Type reference (TYPE)	LOGSYS		Logical system	20070307
10	Importing	IV_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20070307
11	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20070307
12	Importing	IV_PACKAGE_SIZE	Call by reference	☐	Type reference (TYPE)	I	10000	Size of data packages	20070307

Method GET_DP_DATA_ITERATOR on class CL_ESH_IF_BOS_DP_CONTROLLER has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_BOS_DP_CONTROLLER		Data provider controller	20070305

Method GET_INSTANCE on class CL_ESH_IF_BOS_DP_CONTROLLER has no exception.

Method PREPARE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LOG_MESSAGES	Call by reference	☐	Type reference (TYPE)	ESH_T_ADM_BAL_S_MSG		Messages for application log	20070622
2	Exporting	EV_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Flag: Error occured	20070622
3	Importing	IV_CONNECTION_GUID	Call by reference	☐	Type reference (TYPE)	ESH_E_ADM_CONNECTION_GUID		Connection GUID	20071123
4	Importing	IV_LOGSYS	Call by reference	☐	Type reference (TYPE)	LOGSYS		Logical system	20070622
5	Importing	IV_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME		Node Name	20070622
6	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20070622

Method PREPARE_NODE on class CL_ESH_IF_BOS_DP_CONTROLLER has no exception.

History

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