SAP ABAP Class CL_ESH_ADM_CONNECTOR_CAT_MOD (Connector Category assignments)

Hierarchy

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

Properties

Class	CL_ESH_ADM_CONNECTOR_CAT_MOD
Short Description	Connector Category assignments
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_MONITORING_ADMIN	Monitoring and Admin Component
Created	20090422	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_ADM_CONNECTOR_CAT_MOD has no interface implemented.

Friends

Class CL_ESH_ADM_CONNECTOR_CAT_MOD has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_APPLOG	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application log	20090626
2	MO_CL_CATEG_A	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_OM_CATEG		Categories	20090630
3	MO_CL_CATEG_C	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_OM_CATEG		Categories	20090630
4	MO_CL_CATEG_I	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_OM_CATEG		Categories	20090626
5	MO_CL_OTYP_WITHOUT_MOD	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_OM_OTYP		Object types	20090423
6	MO_CL_OTYP_WITH_MOD	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_OM_OTYP		Object types	20090423
7	MO_CL_OTYP_WITH_MOD_I	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ESH_OM_OTYP		Object types	20090626
8	MS_LOCKS	Instance attribute	Protected	☐	Type reference (TYPE)	S_LOCKS		Locks	20090708
9	MT_ACATEG_EXT_SC	Instance attribute	Protected	☐	See coding			Added category assignments	20090630
10	MT_ACATEG_EXT_SC_DEL	Instance attribute	Protected	☐	Attribute reference (LIKE)	MT_ACATEG_EXT_SC		Deleted category assignments	20090630
11	MV_CONNECTION_GUID	Instance attribute	Public	☑	Type reference (TYPE)	ESH_E_ADM_CONNECTION_GUID		Connection GUID	20090422
12	MV_CONNECTOR_ID	Instance attribute	Public	☑	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search connector ID	20090422
13	MV_OBJECT_TYPE_NAME	Instance attribute	Public	☑	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object type	20090422
14	MV_TEMPLATE_TYPE	Instance attribute	Public	☐	Type reference (TYPE)	ESH_E_OM_TEMPLATE_TYPE		Template type	20090925

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CATEGORY_ASSIGNMENTS	Instance method	Public	Method	Add category assignments to connector	20090422
2	CATEGORY_EXISTS	Static method	Public	Method	Check if a category exists	20090430
3	CLEANUP	Instance method	Public	Method	Clean up unsaved changes	20090422
4	CONSTRUCTOR	Instance method	Protected	Constructor	Constructor	20090422
5	COPY_UNAVAILABLE_CATEGORIES	Static method	Protected	Method	Copy unavailable categories to active/inactive area	20090630
6	DELETE_UNUSED_CATEGORIES	Static method	Protected	Method	Delete unavailable categories to active/inactive area	20090630
7	DEL_CATEGORY_ASSIGNMENTS	Instance method	Public	Method	Delete category assignments from connector	20090422
8	GET_ASSIGNED_CATEGORIES	Instance method	Public	Method	Get categories assigned to connector	20090422
9	GET_CATEGORY	Static method	Public	Method	Get a category	20090422
10	GET_INSTANCE	Static method	Public	Method	Get instance	20090422
11	GET_OTYP_INSTANCE_WITH_MOD	Instance method	Protected	Method	Get an instance of OTYP class for enhancements	20090626
12	IS_ENHANCED	Instance method	Public	Method	Connector is enhanced with category assignments	20090717
13	IS_INTERNAL	Instance method	Public	Method	Connector is internal (has internal requests only)	20100812
14	LOCK	Instance method	Public	Method	Set relevant locks	20090430
15	SAVE	Instance method	Public	Method	Save changes	20090422
16	UNLOCK	Instance method	Public	Method	Release locks	20090430

Events

Class CL_ESH_ADM_CONNECTOR_CAT_MOD has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_LOCKS	Protected	See coding		Locks	20090708	BEGIN OF s_locks, connection_area_i TYPE abap_bool, connection_area_a TYPE abap_bool, connector_enhancement TYPE REF TO cl_esh_co_lock, END OF s_locks

Method Signatures

Method ADD_CATEGORY_ASSIGNMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090707
2	Importing	IT_ACATEG_SC	Call by reference	☐	Type reference (TYPE)	ESH_T_OM_ACATEG		Table Type for ESH_S_OM_CATEGORY	20090630

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090707

Method CATEGORY_EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090707
2	Importing	IV_CATEGORY_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_CATEGORY		Category	20090430
3	Returning	RV_TRUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090430

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090707

Method CLEANUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090707

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090707

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090626
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20090422
3	Importing	IV_TEMPLATE_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_TEMPLATE_TYPE		Template Type	20090925

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADM_GENERAL_ERROR	☐	Errors in Monitoring/Admin Component	20090422
2	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090707
3	CX_ESH_CO_INVALID_PARAMETER	☐	Invalid Parameter	20090422
4	CX_ESH_CO_NOT_FOUND	☐	Requested Data not Found	20090422

Method COPY_UNAVAILABLE_CATEGORIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090630
2	Importing	IO_CL_CATEG_A	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_OM_CATEG		Categories	20090630
3	Importing	IO_CL_CATEG_C	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_OM_CATEG		Categories	20090630
4	Importing	IO_CL_CATEG_I	Call by reference	☑	Object reference (TYPE REF TO)	CL_ESH_OM_CATEG		Categories	20090630
5	Importing	IT_ACATEG_EXT_SC	Call by reference	☐	Attribute reference (LIKE)	MT_ACATEG_EXT_SC		Added category assignments	20090630

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090630

Method DELETE_UNUSED_CATEGORIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090630
2	Importing	IO_CL_CATEG_A	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_OM_CATEG		Categories	20090630
3	Importing	IO_CL_CATEG_C	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_OM_CATEG		Categories	20090630
4	Importing	IO_CL_CATEG_I	Call by reference	☑	Object reference (TYPE REF TO)	CL_ESH_OM_CATEG		Categories	20090630
5	Importing	IT_ACATEG_EXT_SC_DEL	Call by reference	☐	Attribute reference (LIKE)	MT_ACATEG_EXT_SC_DEL		Added category assignments	20090630

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090630

Method DEL_CATEGORY_ASSIGNMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090707
2	Importing	IT_ACATEG_SC	Call by reference	☐	Type reference (TYPE)	ESH_T_OM_ACATEG		Table Type for ESH_S_OM_CATEGORY	20090630

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090707

Method GET_ASSIGNED_CATEGORIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ACATEG	Call by reference	☐	Type reference (TYPE)	ESH_T_OM_ACATEG		Table Type for ESH_S_OM_CATEGORY	20090427
2	Exporting	ET_ACATEGT	Call by reference	☐	Type reference (TYPE)	ESH_T_OM_ACATEGT		Table Type for ESH_S_OM_ACATEGT	20090427
3	Exporting	ET_ACATEGT_SC	Call by reference	☐	Type reference (TYPE)	ESH_T_OM_ACATEGT		Table Type for ESH_S_OM_ACATEGT	20090427
4	Exporting	ET_ACATEG_SC	Call by reference	☐	Type reference (TYPE)	ESH_T_OM_ACATEG		Table Type for ESH_S_OM_CATEGORY	20090427
5	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090707
6	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYST-LANGU	SY-LANGU	Language Key of Current Text Environment	20090423

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090707

Method GET_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_ACATEG	Call by reference	☐	Type reference (TYPE)	ESH_S_OM_ACATEG		Structure for ESH_OM_ACATEG	20090430
2	Exporting	ES_ACATEGT	Call by reference	☐	Type reference (TYPE)	ESH_S_OM_ACATEGT		Structure for ACATEGT	20090430
3	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090707
4	Importing	IV_CATEGORY_GUID	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_CATEGORY_GUID		Category GUID	20091106
5	Importing	IV_CATEGORY_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_CATEGORY		Category	20090430

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090707

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application log	20090707
2	Importing	IV_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search connector ID	20090422
3	Importing	IV_TEMPLATE_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_TEMPLATE_TYPE		Template type	20090925
4	Returning	RO_CONNECTOR_CAT_MOD	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_ADM_CONNECTOR_CAT_MOD		Connector category assignments	20090422

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADM_GENERAL_ERROR	☐	Errors in monitoring/admin component	20090422
2	CX_ESH_CO_ENGINE	☐	Common ESH engine exception	20090707
3	CX_ESH_CO_INVALID_PARAMETER	☐	Invalid parameter	20090422
4	CX_ESH_CO_NOT_FOUND	☐	Requested data not found	20090422

Method GET_OTYP_INSTANCE_WITH_MOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090626
2	Importing	IV_CREATE_ENHANCEMENT_STACK	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Create enhancement stack if it is not there yet	20090626
3	Returning	RO_CL_OTYP_WITH_MOD	Value transfer	☐	Attribute reference (LIKE)	MO_CL_OTYP_WITH_MOD		Object Types	20090626

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090707
2	CX_ESH_CO_INVALID_PARAMETER	☐	Invalid Parameter	20090626
3	CX_ESH_CO_NOT_FOUND	☐	Requested Data not Found	20090626

Method IS_ENHANCED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090717
2	Returning	RV_ENHANCED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Connector is enhanced with category assignments	20090717

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090717

Method IS_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20100812
2	Returning	RV_INTERNAL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Connector is internal	20100812

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20100812

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090630

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090707
2	CX_ESH_CO_LOCKED	☐	ESH Locking Exception	20090505

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090630

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090630
2	CX_ESH_CO_LOCKED	☐	ESH Locking Exception	20090707

Method UNLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APPLOG	Call by reference	☐	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20090707

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20090707

History

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