SAP ABAP Class CL_ESH_OM_LOCKS (Locks)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_OBJ_MOD_REP (Package) Model Repository

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_ESH_OM_LOCKS_AUTHC	Lock Authorization Checks	20091217
2	Inheritance (c INHERITING FROM c_ref)	CL_ESH_OM_LOCKS_AUTHONW	Lock Authorization Objects	20091217
3	Inheritance (c INHERITING FROM c_ref)	CL_ESH_OM_LOCKS_DPRVD	Lock Data Providers	20091218
4	Inheritance (c INHERITING FROM c_ref)	CL_ESH_OM_LOCKS_OTYP	Lock Object Types	20091217
5	Inheritance (c INHERITING FROM c_ref)	CL_ESH_OM_LOCKS_RELAT	Lock Relations	20100115

Properties

Class	CL_ESH_OM_LOCKS
Short Description	Locks
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class	ESH_OM_OBJ_MODEL_REP
Program status
Category	0
Package	S_ESH_ENG_OBJ_MOD_REP	Model Repository
Created	20091123	SAP
Last change	20140121	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_ESH_OM_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_ESH_OM_LOCKS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_ESH_OM_LOCKS has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_OM_LOCKS_AUTHC	☐	20091125	Lock Authorization Checks
2	CL_ESH_OM_LOCKS_OTYP	☐	20091125	Lock Object Types

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_DELETED	Constant	Protected	☐	Type reference (TYPE)	ESH_E_OM_UPDATE_FLAG	CL_ESH_OM_CONSTANTS=>GC_DELETED	Update flag	20091125
2	GC_NEW_DELETED	Constant	Protected	☐	Type reference (TYPE)	ESH_E_OM_UPDATE_FLAG	CL_ESH_OM_CONSTANTS=>GC_NEW_DELETED	Update flag	20091125
3	MT_LOCKS	Static Attribute	Protected	☐	Type reference (TYPE)	LTY_T_LOCKS			20091211

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_LOCK_MODEL	Static method	Public	Method	Check if there is a lock for objects of a model	20091215
2	CHECK_MODEL_LOCKED	Static method	Protected	Method	Check if model is locked	20100318
3	DEQUEUE_ENTITY	Static method	Protected	Method	Lock entity	20091125
4	ENQUEUE_ENTITY	Static method	Protected	Method	Lock entity	20091124
5	GET_DEPENDENT_LOCKS	Static method	Protected	Method	Get dependent locks	20100317
6	GET_ENQ_KEY	Static method	Protected	Method	Get enqueue key	20091124
7	GET_ENQ_KEY_ASTERISK	Static method	Public	Method	Get enqueue key	20100415
8	GET_FOREIGN_LOCKS_ENTITY	Static method	Protected	Method	Check lock entity	20100318
9	GET_LOCKS	Static method	Protected	Method	Get entries in admin table	20091125
10	GET_LOCK_OWNERS	Static method	Public	Method	Get lock owners	20091214
11	GET_MESSAGE_CON	Static method	Protected	Method	Get context message	20091124
12	GET_MODEL	Static method	Protected	Method	Get model	20091123
13	GET_MODEL_GUID	Static method	Protected	Method	Get model GUID	20091123
14	GET_OWN_LOCKS_ENTITY	Static method	Protected	Method	Get own locks for an entity	20091221
15	READ_LOCKS	Static method	Protected	Method	Read entry in admin table	20091221
16	REMOVE_DEPENDENT_LOCKS	Static method	Protected	Method	Remove dependent locks	20091127
17	REMOVE_LOCK	Static method	Protected	Method	Remove entry in admin table	20091125
18	SET_LOCK	Static method	Protected	Method	Set entry in admin table	20091124

Events

Class CL_ESH_OM_LOCKS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LTY_S_ENTITY	Protected	See coding			20091125	BEGIN OF lty_s_entity, entity_name TYPE string, causing_lock_guid TYPE guid_32, END OF lty_s_entity
2	LTY_S_LOCKS	Public	See coding			20091125	BEGIN OF lty_s_locks, lock_guid TYPE guid_32, area TYPE esh_e_om_area, model TYPE esh_e_om_model, lock_type type char1, tabname TYPE tabname, object_name TYPE char32, lockmode TYPE enqmode, causing_lock_guid TYPE guid_32, diacount TYPE i, upcount TYPE i, lockname type sy-uname, END OF lty_s_locks
3	LTY_T_ENQ	Public	See coding			20130403	lty_t_enq TYPE TABLE OF seqg3
4	LTY_T_ENTITY	Protected	See coding			20091125	lty_t_entity TYPE SORTED TABLE OF lty_s_entity WITH NON-UNIQUE KEY entity_name
5	LTY_T_LOCKS	Public	See coding			20091125	lty_t_locks TYPE STANDARD TABLE OF lty_s_locks WITH NON-UNIQUE KEY lock_guid WITH NON-UNIQUE SORTED KEY ext COMPONENTS area model lock_type tabname object_name WITH NON-UNIQUE SORTED KEY causing_lock_guid COMPONENTS causing_lock_guid
6	LTY_T_LOCKS_HASHED	Public	See coding			20091125	lty_t_locks_hashed TYPE HASHED TABLE OF lty_s_locks WITH UNIQUE KEY lock_guid WITH NON-UNIQUE SORTED KEY ext COMPONENTS area model lock_type tabname object_name WITH NON-UNIQUE SORTED KEY causing_lock_guid COMPONENTS causing_lock_guid

Method Signatures

Method CHECK_LOCK_MODEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ENQ	Call by reference	☐	Type reference (TYPE)	LTY_T_ENQ			20130403
2	Importing	IR_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20091216
3	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AREA		Area	20091215
4	Importing	IV_LOCKMODE	Call by reference	☐	Type reference (TYPE)	ENQMODE		Lock mode	20091215
5	Importing	IV_MODEL	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_MODEL		Model	20091215
6	Returning	RV_LOCKNAME	Value transfer	☐	Type reference (TYPE)	EQEUNAME		User Name	20091216

#	Exception	Resumable	Description	Created on
1	CX_ESH_OM_ENGINE	☐	ESH Object Model Exception	20091216

Method CHECK_MODEL_LOCKED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_CONTEXT	Call by reference	☐	Type reference (TYPE)	XFELD		Checkbox	20100318
2	Importing	IR_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20100318
3	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AREA		Area	20100318
4	Importing	IV_CONTEXT	Call by reference	☐	Type reference (TYPE)	XFELD		Checkbox	20100318
5	Importing	IV_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100318
6	Importing	IV_FOCUS_NAME	Call by reference	☐	Type reference (TYPE)	NAME_KOMP		Component name	20100318
7	Importing	IV_LOCKMODE	Call by reference	☑	Type reference (TYPE)	ENQMODE		Lock mode	20100318
8	Importing	IV_MODEL	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_MODEL		Model	20100318
9	Importing	IV_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20100318

#	Exception	Resumable	Description	Created on
1	CX_ESH_OM_ENGINE	☐	ESH Object Model Exception	20100318

Method DEQUEUE_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ENTITY	Call by reference	☑	Type reference (TYPE)	LTY_T_ENTITY			20091125
2	Importing	IT_LOCKS	Call by reference	☑	Type reference (TYPE)	LTY_T_LOCKS			20091127
3	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AREA		Area	20091125
4	Importing	IV_LOCKMODE	Call by reference	☐	Type reference (TYPE)	ENQMODE	'E'	Lock mode	20091125
5	Importing	IV_LOCK_TYPE	Call by reference	☑	Type reference (TYPE)	CHAR1		Single-Character Flag	20091222
6	Importing	IV_MODEL	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_MODEL		Model	20091125
7	Importing	IV_MODEL_GUID	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL_GUID		Model GUID	20091125
8	Importing	IV_TABNAME	Call by reference	☑	Type reference (TYPE)	TABNAME		Application Log: Context: DDIC structure name	20091127

#	Exception	Resumable	Description	Created on
1	CX_ESH_OM_ENGINE	☐	ESH Object Model Exception	20091125

Method ENQUEUE_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LOCKS	Call by reference	☐	Type reference (TYPE)	LTY_T_LOCKS			20091127
2	Importing	IR_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20091124
3	Importing	IS_MESSAGE_1	Call by reference	☐	Type reference (TYPE)	BAL_S_MSG		Application Log: Message Data	20091124
4	Importing	IS_MESSAGE_2	Call by reference	☐	Type reference (TYPE)	BAL_S_MSG		Application Log: Message Data	20091124
5	Importing	IT_ENTITY	Call by reference	☑	Type reference (TYPE)	LTY_T_ENTITY			20091124
6	Importing	IV_ACCUMULATE	Call by reference	☐	Type reference (TYPE)	XFELD	ABAP_TRUE	Checkbox	20100216
7	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AREA		Area	20091124
8	Importing	IV_CONTEXT	Call by reference	☐	Type reference (TYPE)	XFELD	ABAP_FALSE	Checkbox	20091124
9	Importing	IV_EXC_FOREIGN_LOCK	Call by reference	☐	Type reference (TYPE)	XFELD	ABAP_TRUE	Checkbox	20100317
10	Importing	IV_FOCUS_NAME	Call by reference	☐	Type reference (TYPE)	NAME_KOMP		Component name	20091124
11	Importing	IV_LOCKMODE	Call by reference	☐	Type reference (TYPE)	ENQMODE	'E'	Lock mode	20091124
12	Importing	IV_LOCK_TYPE	Call by reference	☑	Type reference (TYPE)	CHAR1		Single-Character Flag	20091222
13	Importing	IV_MODEL	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_MODEL		Model	20091124
14	Importing	IV_MODEL_GUID	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL_GUID		Model GUID	20091124
15	Importing	IV_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	BALTABNAME		Application Log: Context: DDIC structure name	20091124
16	Importing	IV_TABNAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20091127

#	Exception	Resumable	Description	Created on
1	CX_ESH_OM_ENGINE	☐	ESH Object Model Exception	20091124

Method GET_DEPENDENT_LOCKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_LOCKS	Call by reference	☑	Type reference (TYPE)	LTY_T_LOCKS			20100317
2	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AREA		Area	20100317
3	Importing	IV_MODEL	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_MODEL		Model	20100317
4	Returning	RT_LOCKS	Value transfer	☐	Type reference (TYPE)	LTY_T_LOCKS			20100317

#	Exception	Resumable	Description	Created on
1	CX_ESH_OM_ENGINE	☐	ESH Object Model Exception	20100317

Method GET_ENQ_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20091124
2	Importing	IV_LOCK_TYPE	Call by reference	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20091222
3	Importing	IV_TABNAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Model	20091216
4	Returning	RV_ENQ_KEY	Value transfer	☐	Type reference (TYPE)	VIM_ENQKEY		Lock key for tables	20091124

Method GET_ENQ_KEY on class CL_ESH_OM_LOCKS has no exception.

Method GET_ENQ_KEY_ASTERISK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AREA		Area	20100415
2	Returning	RV_ENQ_KEY	Value transfer	☐	Type reference (TYPE)	VIM_ENQKEY		Lock key for tables	20100415

Method GET_ENQ_KEY_ASTERISK on class CL_ESH_OM_LOCKS has no exception.

Method GET_FOREIGN_LOCKS_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_APPLOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20100318
2	Importing	IS_ENTITY	Call by reference	☐	Type reference (TYPE)	LTY_S_ENTITY			20100318
3	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AREA		Area	20100318
4	Importing	IV_LOCKMODE	Call by reference	☐	Type reference (TYPE)	ENQMODE	'E'	Lock mode	20100318
5	Importing	IV_LOCK_TYPE	Call by reference	☑	Type reference (TYPE)	CHAR1		Single-Character Flag	20100318
6	Importing	IV_MODEL	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_MODEL		Model	20100318
7	Importing	IV_MODEL_GUID	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL_GUID		Model GUID	20100318
8	Importing	IV_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	BALTABNAME		Application Log: Context: DDIC structure name	20100318
9	Importing	IV_TABNAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20100318
10	Returning	RT_LOCKS	Value transfer	☐	Type reference (TYPE)	LTY_T_LOCKS			20100318

#	Exception	Resumable	Description	Created on
1	CX_ESH_OM_ENGINE	☐	ESH Object Model Exception	20100318

Method GET_LOCKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LOCKS	Call by reference	☐	Type reference (TYPE)	LTY_T_LOCKS			20091125
2	Importing	IT_LOCKS	Call by reference	☐	Type reference (TYPE)	LTY_T_LOCKS			20091125

Method GET_LOCKS on class CL_ESH_OM_LOCKS has no exception.

Method GET_LOCK_OWNERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_GUSR	Call by reference	☐	Type reference (TYPE)	EQEUSR		Lock Owner, ID of Logical Unit of Work (LUW)	20091214
2	Exporting	EV_GUSRVB	Call by reference	☐	Type reference (TYPE)	EQEUSRVB		Lock Owner, ID of Logical Unit of Work (LUW) /Update Task	20091214
3	Importing	IR_APPLOG	Call by reference	☐	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20110222

#	Exception	Resumable	Description	Created on
1	CX_ESH_OM_ENGINE	☐	ESH Object Model Exception	20110222

Method GET_MESSAGE_CON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AREA		Area	20091124
2	Importing	IV_MODEL	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_MODEL		Model	20091124
3	Returning	RS_MESSAGE	Value transfer	☐	Type reference (TYPE)	BAL_S_MSG		Application Log: Message Data	20091124

Method GET_MESSAGE_CON on class CL_ESH_OM_LOCKS has no exception.

Method GET_MODEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AREA		Area	20091123
2	Importing	IV_MODEL_GUID	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_MODEL_GUID		Model GUID	20091123
3	Returning	RV_MODEL	Value transfer	☐	Type reference (TYPE)	ESH_E_OM_MODEL		Model	20091123

Method GET_MODEL on class CL_ESH_OM_LOCKS has no exception.

Method GET_MODEL_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AREA		Area	20091123
2	Importing	IV_MODEL	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_MODEL		Model	20091123
3	Importing	IV_SYSREL	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL		Software Component	20091123
4	Returning	RV_MODEL_GUID	Value transfer	☐	Type reference (TYPE)	ESH_E_OM_MODEL_GUID		Model GUID	20091123

Method GET_MODEL_GUID on class CL_ESH_OM_LOCKS has no exception.

Method GET_OWN_LOCKS_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ENTITY	Call by reference	☑	Type reference (TYPE)	LTY_S_ENTITY			20091221
2	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AREA		Area	20091221
3	Importing	IV_LOCKMODE	Call by reference	☐	Type reference (TYPE)	ENQMODE	'E'	Lock mode	20091221
4	Importing	IV_LOCK_TYPE	Call by reference	☑	Type reference (TYPE)	CHAR1		Single-Character Flag	20091222
5	Importing	IV_MODEL	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_MODEL		Model	20091221
6	Importing	IV_MODEL_GUID	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_SYSREL_GUID		Model GUID	20091221
7	Importing	IV_TABNAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20091221
8	Returning	RT_LOCKS	Value transfer	☐	Type reference (TYPE)	LTY_T_LOCKS			20091221

Method GET_OWN_LOCKS_ENTITY on class CL_ESH_OM_LOCKS has no exception.

Method READ_LOCKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LOCKS	Call by reference	☐	Type reference (TYPE)	LTY_S_LOCKS			20091221
2	Returning	RT_LOCKS	Value transfer	☐	Type reference (TYPE)	LTY_T_LOCKS			20091221

Method READ_LOCKS on class CL_ESH_OM_LOCKS has no exception.

Method REMOVE_DEPENDENT_LOCKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_LOCKS	Call by reference	☑	Type reference (TYPE)	LTY_T_LOCKS			20091127
2	Importing	IV_AREA	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_AREA		Area	20091127
3	Importing	IV_MODEL	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_MODEL		Model	20091218

#	Exception	Resumable	Description	Created on
1	CX_ESH_OM_ENGINE	☐	ESH Object Model Exception	20091127

Method REMOVE_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_LOCKS	Call by reference	☐	Object reference (TYPE REF TO)	LTY_S_LOCKS			20091218

Method REMOVE_LOCK on class CL_ESH_OM_LOCKS has no exception.

Method SET_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_LOCKS	Call by reference	☐	Object reference (TYPE REF TO)	LTY_S_LOCKS			20091124

Method SET_LOCK on class CL_ESH_OM_LOCKS has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	730