SAP ABAP Class CL_CRM_ES_MGR (CRM ES Manager)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-ES (Application Component) Enterprise Search Integration
     ⤷ CRM_ES_MGR (Package) Enterprise Search Manager CRM

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	20080220
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_DATA_PROVIDER_INCL	Instances of included interfaces of data provider	20080220
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_OBJECT_DATA_BY_ID	Object data by list of object ids	20080220
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_OBJECT_DESCRIPTOR	Object type descriptor	20080220
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_OBJECT_ITERATOR	Object data iterator by last object id	20080220
6	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_OBJECT_TYPES_LIST	Object type list	20080220
7	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_IF_OBJECT_TYPE_BY_ID	Object type by ID	20080220

Properties

Class	CL_CRM_ES_MGR
Short Description	CRM ES Manager
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	CRM_ES_MGR	Enterprise Search Manager CRM
Created	20080220	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)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_IF_DATA_PROVIDER	☐	☐	Data provider	20080220
2	IF_ESH_IF_DATA_PROVIDER_INCL	☐	☐	Instances of included interfaces of data provider	20080220
3	IF_ESH_IF_OBJECT_DATA_BY_ID	☐	☐	Object data by list of object ids	20080220
4	IF_ESH_IF_OBJECT_DESCRIPTOR	☐	☐	Object type descriptor	20080220
5	IF_ESH_IF_OBJECT_ITERATOR	☐	☐	Object data iterator by last object id	20080220
6	IF_ESH_IF_OBJECT_TYPES_LIST	☐	☐	Object type list	20080220
7	IF_ESH_IF_OBJECT_TYPE_BY_ID	☐	☐	Object type by ID	20080220

Friends

Class CL_CRM_ES_MGR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_CLASS_NAME	Constant	Protected	☐	Type reference (TYPE)	SEOCLSNAME	'CL_CRM_ES_MGR'	ES implementation class	20080221
2	GC_CP_CHILD_TOUCHED	Constant	Public	☐	Type reference (TYPE)	CRM_ES_OPERATION	'U'	Change pointer operation child touched	20080417
3	GC_CP_ROOT_CREATED	Constant	Public	☐	Type reference (TYPE)	CRM_ES_OPERATION	'C'	Change pointer operation root created	20080417
4	GC_CP_ROOT_DELETED	Constant	Public	☐	Type reference (TYPE)	CRM_ES_OPERATION	'D'	Change pointer operation root created	20080417
5	GC_CP_ROOT_UPDATED	Constant	Public	☐	Type reference (TYPE)	CRM_ES_OPERATION	'U'	Change pointer operation root created	20080417
6	GC_CRM_COMPONENT	Constant	Public	☐	Type reference (TYPE)	DLVUNIT	'BBPCRM'	CRM software component under which CRM templates are stored	20080306
7	GR_ES_MGR	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_CRM_ES_MGR		Current CRM ES Manager instance	20080221
8	GR_EXTRACT_MGR	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_CRM_ES_EXTRACT_MANAGER		Current CRM ES Extraction Manager instance	20080221
9	GR_MODEL_MGR	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_CRM_ES_MODEL_MGR		Current CRM ES Modeling Manager instance	20080221
10	GT_CONNECTOR_IDS	Static Attribute	Private	☐	Type reference (TYPE)	ESH_T_IF_MDATA_CONNECTORS		Cached Enterprise Search Connectors	20080618
11	GV_COMPONENT	Static Attribute	Private	☐	Type reference (TYPE)	DLVUNIT		Software Component	20080425
12	GV_DATA_PROVIDER	Static Attribute	Private	☐	Type reference (TYPE)	ESH_E_IF_PROVIDER_ID	'CL_CRM_ES_MGR'	Search data provider id	20101027
13	GV_ROOT_NODE_READ	Static Attribute	Private	☐	Type reference (TYPE)	BOOLEAN		Root node read in NEXT method	20101011
14	GV_SOFTWARE_COMPONENT	Static Attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		Software Component	20100806
15	GV_TEMPLATE	Static Attribute	Private	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Current template id processed	20080304

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHK_TEMPLATE_DELETED_IN_ES	Static method	Public	Method	Check that a template has been deleted in Enterprise Search	20090126
2	GET_COMP_FOR_MODEL_TRANSFER	Static method	Public	Method	Retrieves all components that can be used for model transfer	20080414
3	GET_CONNECTOR_ID	Static method	Public	Method	Gets connector id for template	20080505
4	GET_CURRENT_TEMPLATE	Static method	Protected	Method	Gets current template id	20080306
5	GET_ES_MGR_REF	Static method	Private	Method	Gets Model Manager reference	20080306
6	GET_INSTANCE	Static method	Private	Method	Controls singleton instance of CRM ES Manager	20080304
7	GET_MODELING_CLIENT	Static method	Public	Method	Gets CRM ES modeling client	20080429
8	GET_MODEL_MGR_REF	Static method	Protected	Method	Gets Model Manager reference	20080306
9	GET_SOFTWARE_COMPONENT	Static method	Protected	Method	Sets current template id	20100806
10	NOTIFY_CHANGES	Static method	Public	Method	API for applications to notify object changes	20080220
11	READ_MODEL_FROM_CRM	Static method	Public	Method	Read template model from CRM database	20101027
12	READ_ROOT_NODE	Static method	Private	Method	Read root node before extraction starts	20101011
13	SET_COMP_FOR_MODEL_TRANSFER	Static method	Public	Method	Retrieves all components that can be used for model transfer	20080508
14	SET_CURRENT_COMPONENT	Static method	Private	Method	Sets component for model transfer	20080425
15	SET_CURRENT_TEMPLATE	Static method	Protected	Method	Sets current template id	20080306
16	SET_DATA_PROVIDER	Static method	Public	Method	Set search data provider id	20101027
17	SET_ES_MGR_REF	Static method	Protected	Method	Sets Model Manager reference	20080306
18	SET_MODEL_MGR_REF	Static method	Protected	Method	Sets Model Manager reference	20080306
19	SET_SOFTWARE_COMPONENT	Static method	Protected	Method	Sets current template id	20100806
20	TRANSFER_MODEL	Static method	Private	Method	Transfer CRM model to ES	20080220
21	TRANSFER_MODEL_REQ_RESP	Static method	Public	Method	Transfer CRM model to ES	20080714
22	TRANSFER_REQUESTS	Static method	Private	Method	Transfer CRM template requests	20080709
23	TRANSFER_RESPONSES	Static method	Private	Method	Transfer CRM template response	20080709

Events

Class CL_CRM_ES_MGR has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_LS_ROOT_NODE	Private	See coding			20101015	begin of ty_ls_root_node, comp_set type crmt_bsp_appl, bol_root_obj type crmt_ext_obj_name, end of ty_ls_root_node

Method Signatures

Method CHK_TEMPLATE_DELETED_IN_ES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	IR_MESSAGES	Call by reference	☐	Object reference (TYPE REF TO)	BAPIRETTAB		Table with BAPI Return Information	20090126
2	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_ID		Template id	20090126

#	Exception	Resumable	Description	Created on
1	CX_CRM_ES_FAULT	☐	CRM ES exception class	20090126

Method GET_COMP_FOR_MODEL_TRANSFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_COMPONENT	Call by reference	☐	Type reference (TYPE)	CRMT_ES_COMPONENT		Components	20080414

Method GET_COMP_FOR_MODEL_TRANSFER on class CL_CRM_ES_MGR has no exception.

Method GET_CONNECTOR_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXCEPTION_IF_NOT_SEARCHABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20080505
2	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20080505
3	Returning	RV_CONNECTOR_ID	Value transfer	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20080505

Method GET_CONNECTOR_ID on class CL_CRM_ES_MGR has no exception.

Method GET_CURRENT_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TEMPLATE_ID	Value transfer	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Template id	20080306

Method GET_CURRENT_TEMPLATE on class CL_CRM_ES_MGR has no exception.

Method GET_ES_MGR_REF 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_CRM_ES_MGR		CRM ES Manager class	20080306

Method GET_ES_MGR_REF on class CL_CRM_ES_MGR 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_CRM_ES_MGR		CRM ES Manager	20080304

Method GET_INSTANCE on class CL_CRM_ES_MGR has no exception.

Method GET_MODELING_CLIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_MODELING_CLIENT	Call by reference	☐	Type reference (TYPE)	CRM_ES_CLIENT		Client	20080429

#	Exception	Resumable	Description	Created on
1	CX_CRM_ES_FAULT	☐	CRM ES exception class	20080429

Method GET_MODEL_MGR_REF 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_CRM_ES_MODEL_MGR		ES Modeling Manager Class	20080306

Method GET_MODEL_MGR_REF on class CL_CRM_ES_MGR has no exception.

Method GET_SOFTWARE_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SOFTWARE_COMPONENT	Value transfer	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		Template id	20100806

Method GET_SOFTWARE_COMPONENT on class CL_CRM_ES_MGR has no exception.

Method NOTIFY_CHANGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_MESSAGE	Call by reference	☑	Object reference (TYPE REF TO)	BAPIRETTAB		Table with BAPI Return Information	20080424
2	Importing	IS_CRM_CHANGE_POINTER	Call by reference	☑	Type reference (TYPE)	CRMS_ES_CHANGE_POINTER		Change pointer structure of CRM applications	20080220
3	Importing	IT_CRM_CHANGE_POINTER	Call by reference	☑	Type reference (TYPE)	CRMT_ES_CHANGE_POINTER		Table of change pointers	20080414

#	Exception	Resumable	Description	Created on
1	CX_CRM_ES_FAULT	☐	CRM ES exception class	20080417

Method READ_MODEL_FROM_CRM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_RESULT	Value transfer	☐	Type reference (TYPE)	BOOLEAN		X = read template model from CRM ('old' templates)	20101027

Method READ_MODEL_FROM_CRM on class CL_CRM_ES_MGR has no exception.

Method READ_ROOT_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_NODES	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_EXTRACT_NODES		Extraction of nodes	20101011
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	TY_LS_ROOT_NODE		Root node (component set, BOL root object)	20101011

Method READ_ROOT_NODE on class CL_CRM_ES_MGR has no exception.

Method SET_COMP_FOR_MODEL_TRANSFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_COMPONENT	Value transfer	☐	Type reference (TYPE)	DLVUNIT		Software Component	20080508

Method SET_COMP_FOR_MODEL_TRANSFER on class CL_CRM_ES_MGR has no exception.

Method SET_CURRENT_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	DLVUNIT		Software Component	20080425

Method SET_CURRENT_COMPONENT on class CL_CRM_ES_MGR has no exception.

Method SET_CURRENT_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Template id	20080306

Method SET_CURRENT_TEMPLATE on class CL_CRM_ES_MGR has no exception.

Method SET_DATA_PROVIDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_DATA_PROVIDER	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_PROVIDER_ID		Search data provider id	20101027

Method SET_DATA_PROVIDER on class CL_CRM_ES_MGR has no exception.

Method SET_ES_MGR_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CRM_ES_MGR		CRM ES Manager class	20080306

Method SET_ES_MGR_REF on class CL_CRM_ES_MGR has no exception.

Method SET_MODEL_MGR_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CRM_ES_MODEL_MGR		ES Modeling Manager Class	20080306

Method SET_MODEL_MGR_REF on class CL_CRM_ES_MGR has no exception.

Method SET_SOFTWARE_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SOFTWARE_COMPONENT	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		Template id	20100806

Method SET_SOFTWARE_COMPONENT on class CL_CRM_ES_MGR has no exception.

Method TRANSFER_MODEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	DLVUNIT		Software Component	20080414
2	Importing	IV_TEMPLATE_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	CRM_ES_DESCRIPTION		Descriptions for CRM ES	20080422
3	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_ID		Template ID for CRM ES	20080222
4	Importing	IV_TEMPLATE_SET_ID	Call by reference	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_SET		Template set ID	20080422

#	Exception	Resumable	Description	Created on
1	CX_CRM_ES_FAULT	☐	CRM ES exception class	20080314

Method TRANSFER_MODEL_REQ_RESP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_ERROR_FLAGS	Call by reference	☐	Type reference (TYPE)	CRMS_ES_TRANSFER_OPTIONS		Error flags for model transfer	20080714
2	Importing	IS_TRANSFER_OPTIONS	Call by reference	☐	Type reference (TYPE)	CRMS_ES_TRANSFER_OPTIONS		Model transfer options	20080714
3	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	DLVUNIT		Software Component	20080714
4	Importing	IV_TEMPLATE_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	CRM_ES_DESCRIPTION		Descriptions for CRM ES	20080714
5	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_ID		Template ID for CRM ES	20080714
6	Importing	IV_TEMPLATE_SET_ID	Call by reference	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_SET		Template set ID	20080714

#	Exception	Resumable	Description	Created on
1	CX_CRM_ES_FAULT	☐	CRM ES exception class	20080714

Method TRANSFER_REQUESTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	DLVUNIT		Software component	20080709
2	Importing	IV_TEMPLATE_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	CRM_ES_DESCRIPTION		template description	20080709
3	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_ID		Template id	20080709
4	Importing	IV_TEMPLATE_SET_ID	Call by reference	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_SET		Template set id	20080709

#	Exception	Resumable	Description	Created on
1	CX_CRM_ES_FAULT	☐	CRM ES exception class	20080709

Method TRANSFER_RESPONSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPONENT	Call by reference	☐	Type reference (TYPE)	DLVUNIT		Software component	20080709
2	Importing	IV_TEMPLATE_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	CRM_ES_DESCRIPTION		template description	20080709
3	Importing	IV_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_ID		Template id	20080709
4	Importing	IV_TEMPLATE_SET_ID	Call by reference	☐	Type reference (TYPE)	CRM_ES_TEMPLATE_SET		Template set id	20080709

#	Exception	Resumable	Description	Created on
1	CX_CRM_ES_FAULT	☐	CRM ES exception class	20080709

History

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