SAP ABAP Class CL_ESH_IF_DATA_PROVIDER_BADI (Data Provider for BAdIs)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_INTERFACE (Package) Interface

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_DATA_PROVIDER	Data provider	20080118
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_DATA_PROVIDER_INCL	Instances of included interfaces of data provider	20080118
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_OBJECT_DATA_BY_ID	Object data by list of object ids	20080118
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_OBJECT_EXTR_PREP	Object data extraction preparation (internal!)	20100806
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_OBJECT_ITERATOR	Object data iterator by last object id	20080118
6	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_OBJECT_ITERATOR_TIME	Object data iterator by last timestamp	20090119

Properties

Class	CL_ESH_IF_DATA_PROVIDER_BADI
Short Description	Data Provider for BAdIs
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_INTERFACE	Interface
Created	20080118	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

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_IF_DATA_PROVIDER	☐	☐	Data provider	20080118
2	IF_ESH_IF_DATA_PROVIDER_INCL	☐	☐	Instances of included interfaces of data provider	20080118
3	IF_ESH_IF_OBJECT_DATA_BY_ID	☐	☐	Object data by list of object ids	20080118
4	IF_ESH_IF_OBJECT_EXTR_PREP	☐	☐	Object data extraction preparation (internal!)	20100806
5	IF_ESH_IF_OBJECT_ITERATOR	☐	☐	Object data iterator by last object id	20080118
6	IF_ESH_IF_OBJECT_ITERATOR_TIME	☐	☐	Object data iterator by last timestamp	20090119

Friends

Class CL_ESH_IF_DATA_PROVIDER_BADI has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_BADI	Instance attribute	Private	☐	Object reference (TYPE REF TO)	BADI_ESH_IF_OBJECT_DATA			20080118
2	MR_BADI_TIME	Instance attribute	Private	☐	Object reference (TYPE REF TO)	BADI_ESH_IF_OBJECT_DATA_TS			20090119
3	MT_BADI_ENH	Instance attribute	Private	☐	Type reference (TYPE)	LTT_ENHANCEMENT_BADIS			20080505
4	MT_BADI_OBJ_EXTR_PREP	Instance attribute	Private	☐	Type reference (TYPE)	LTT_OBJ_EXTR_PREP_BADIS			20100806
5	MT_BADI_TIME_ENH	Instance attribute	Private	☐	Type reference (TYPE)	LTT_ENHANCEMENT_TIME_BADIS			20090119
6	MV_HOME_SOFTWARE_COMPONENT	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		System/release	20090126
7	MV_OBJECT_TYPE_BACKEND_NAME	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Back-end name	20080118
8	MV_OBJECT_TYPE_ID	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object type	20080118
9	SC_INTERFACE_EXTRACTION_PREP	Constant	Private	☐	Type reference (TYPE)	CHAR30	'IF_ESH_IF_OBJECT_EXTR_PREP'	Interface: Extraction preparation	20100806
10	SC_INTERFACE_ITERATOR	Constant	Private	☐	Type reference (TYPE)	CHAR30	'IF_ESH_IF_OBJECT_ITERATOR'	Interface: Iterator	20090119
11	SC_INTERFACE_ITERATOR_DATA	Constant	Private	☐	Type reference (TYPE)	CHAR30	'IF_ESH_IF_OBJECT_ITERATOR_DATA'	Interface: Data by ID	20090119
12	SC_INTERFACE_ITERATOR_TIME	Constant	Private	☐	Type reference (TYPE)	CHAR30	'IF_ESH_IF_OBJECT_ITERATOR_TIME'	Interface: Iterator time	20090119
13	SC_PROVIDER_ID	Constant	Private	☐	Type reference (TYPE)	ESH_E_IF_PROVIDER_ID	'CL_ESH_IF_DATA_PROVIDER_BADI'	Provider ID	20080118

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_BADI_DETAILS_TO_CX_MSG	Static method	Private	Method	Add BAdI implementation details to exception messages	20100810
2	CONSTRUCTOR	Instance method	Protected	Constructor	Constructor	20080118
3	GET_INSTANCE	Static method	Protected	Method	Get an instance	20080118
4	GET_OBJECT_EXTR_PREP_BADIS	Instance method	Private	Method	Get existing iterator BAdIs	20100806
5	GET_OBJECT_ITERATOR_BADIS	Instance method	Private	Method	Get existing iterator BAdIs	20090119
6	GET_OBJECT_ITERATOR_TIME_BADIS	Instance method	Private	Method	Get existing iterator BAdIs	20090119
7	GET_SOFTWARE_COMPONENTS	Static method	Private	Method	Get relevant software components	20080505

Events

Class CL_ESH_IF_DATA_PROVIDER_BADI has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LST_ENHANCEMENT_BADI	Private	See coding			20080505	BEGIN OF lst_enhancement_badi, software_component TYPE esh_e_om_sysrel, instance TYPE REF TO badi_esh_if_object_data_enh, END OF lst_enhancement_badi
2	LST_ENHANCEMENT_TIME_BADI	Private	See coding			20090119	BEGIN OF lst_enhancement_time_badi, software_component TYPE esh_e_om_sysrel, instance TYPE REF TO badi_esh_if_object_data_ts_enh, END OF lst_enhancement_time_badi
3	LST_OBJ_EXTR_PREP_BADI	Private	See coding			20100806	BEGIN OF lst_obj_extr_prep_badi, software_component TYPE esh_e_om_sysrel, instance TYPE REF TO badi_esh_if_obj_extr_prep, END OF lst_obj_extr_prep_badi
4	LST_SOFTWARE_COMPONENT	Private	See coding			20080505	BEGIN OF lst_software_component, layer_top_down TYPE i, software_component TYPE esh_e_om_sysrel, END OF lst_software_component
5	LTT_ENHANCEMENT_BADIS	Private	See coding			20080505	ltt_enhancement_badis TYPE STANDARD TABLE OF lst_enhancement_badi
6	LTT_ENHANCEMENT_TIME_BADIS	Private	See coding			20090119	ltt_enhancement_time_badis TYPE STANDARD TABLE OF lst_enhancement_time_badi
7	LTT_OBJ_EXTR_PREP_BADIS	Private	See coding			20100806	ltt_obj_extr_prep_badis TYPE STANDARD TABLE OF lst_obj_extr_prep_badi
8	LTT_SOFTWARE_COMPONENTS	Private	See coding			20080505	ltt_software_components TYPE STANDARD TABLE OF lst_software_component

Method Signatures

Method ADD_BADI_DETAILS_TO_CX_MSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_BADI	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT			20100810
2	Importing	IX_PROVIDER_ERROR	Call by reference	☐	Object reference (TYPE REF TO)	CX_ESH_IF_PROVIDER_ERROR		General error in provider	20100810

Method ADD_BADI_DETAILS_TO_CX_MSG on class CL_ESH_IF_DATA_PROVIDER_BADI has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CHANGEPOINTER_SUPPORT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20080730
2	Importing	IV_HOME_SOFTWARE_COMPONENT	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL		System/release	20090126
3	Importing	IV_INTERFACE_NAME	Call by reference	☑	Type reference (TYPE)	CHAR30		30 characters	20090119
4	Importing	IV_OBJECT_TYPE_BACKEND_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Back-end name	20080118
5	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object type	20080118

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_NOT_SUPPORTED	☐	Interface not supported	20090507
2	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20080118

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CHANGEPOINTER_SUPPORT	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20080730
2	Importing	IV_HOME_SOFTWARE_COMPONENT	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL		System/release	20090126
3	Importing	IV_INTERFACE_NAME	Call by reference	☑	Type reference (TYPE)	CHAR30		30 characters	20090119
4	Importing	IV_OBJECT_TYPE_BACKEND_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Back-end name	20080118
5	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object type	20080118
6	Returning	RR_DATA_PROVIDER_BADI	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_DATA_PROVIDER_BADI		Data provider for BAdIs	20080118

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_NOT_SUPPORTED	☐	Interface not supported	20090507
2	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20080118

Method GET_OBJECT_EXTR_PREP_BADIS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HOME_SOFTWARE_COMPONENT	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL		System/release	20100806
2	Importing	IV_INTERFACE_NAME	Call by reference	☐	Type reference (TYPE)	CHAR30		30 characters	20100806
3	Importing	IV_OBJECT_TYPE_BACKEND_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Back-end name	20100806
4	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object type	20100806

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_NOT_SUPPORTED	☐	Interface not supported	20100806
2	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20100806

Method GET_OBJECT_ITERATOR_BADIS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CHANGEPOINTER_SUPPORT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20090119
2	Importing	IV_HOME_SOFTWARE_COMPONENT	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL		System/release	20090126
3	Importing	IV_INTERFACE_NAME	Call by reference	☐	Type reference (TYPE)	CHAR30		30 characters	20090119
4	Importing	IV_OBJECT_TYPE_BACKEND_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Back-end name	20090119
5	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object type	20090119

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_NOT_SUPPORTED	☐	Interface not supported	20090507
2	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20090119

Method GET_OBJECT_ITERATOR_TIME_BADIS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HOME_SOFTWARE_COMPONENT	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL		System/release	20090126
2	Importing	IV_INTERFACE_NAME	Call by reference	☐	Type reference (TYPE)	CHAR30		30 characters	20090119
3	Importing	IV_OBJECT_TYPE_BACKEND_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Back-end name	20090119
4	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object type	20090119

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_NOT_SUPPORTED	☐	Interface not supported	20090507
2	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20090119

Method GET_SOFTWARE_COMPONENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SOFTWARE_COMPONENTS	Call by reference	☐	Type reference (TYPE)	LTT_SOFTWARE_COMPONENTS			20080505
2	Importing	IV_HOME_SOFTWARE_COMPONENT	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL		Software component	20090203
3	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object type	20080505

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20081204

History

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