SAP ABAP Class CL_ESH_CO_LOCK (Lock on a Database Table)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_COMMON (Package) Common
Properties
Class CL_ESH_CO_LOCK  
Short Description Lock on a Database Table    
Super Class    
Instantiability of a Class 1  Protected 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_ENG_COMMON   Common 
Created 20061008   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_CO_LOCK has no interface implemented.
Friends
Class CL_ESH_CO_LOCK has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MR_ANY_KEY Instance attribute Public Object reference (TYPE REF TO) DATA 20070404
2 MV_CLIENT_ADDED Instance attribute Public Type reference (TYPE) XFLAG Client added to the lock argument 20100810
3 MV_LOCKED Instance attribute Public Type reference (TYPE) XFLAG New input values 20061008
4 MV_LOCK_MODE Instance attribute Public Type reference (TYPE) DD26E-ENQMODE Lock mode 20061008
5 MV_NO_TABLE_KEY Instance attribute Public Type reference (TYPE) XFLAG No table key 20061008
6 MV_NO_TABLE_NAME Instance attribute Public Type reference (TYPE) XFLAG No table name 20061008
7 MV_TABLE_KEY Instance attribute Public Type reference (TYPE) RSTABLE-VARKEY Lock key for tables 20061008
8 MV_TABLE_NAME Instance attribute Public Type reference (TYPE) RSTABLE-TABNAME Table name 20061008
9 SC_LOCK_MODE_EXCLUSIVE Constant Public Type reference (TYPE) ENQMODE 'E' Exclusive lock 20061008
10 SC_LOCK_MODE_EXT_EXCLUSIVE Constant Public Type reference (TYPE) ENQMODE 'X' Extended exclusive lock 20061008
11 SC_LOCK_MODE_SHARED Constant Public Type reference (TYPE) ENQMODE 'S' Shared lock 20061008
12 SC_MY_CLASS_NAME Constant Protected Type reference (TYPE) TABNAME 'CL_ESH_CO_LOCK' The name of the current class 20070404
13 SV_TABLE_KEY Static Attribute Public Type reference (TYPE) RSTABLE-VARKEY Lock key for tables 20061008
Methods
# Method Level Visibility Method type Description Created on
1 GET_TABLE_KEY Static method Public Method Compose the table key by its components 20061008
2 LOCK Static method Public Method Set a lock 20061008
3 UNLOCK Instance method Public Method Release a lock 20061008
4 UNLOCK_LIST Static method Public Method Release a list of locks 20061008
Events
Class CL_ESH_CO_LOCK has no event.
Types
Class CL_ESH_CO_LOCK has no local type.
Method Signatures

Method GET_TABLE_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FIELD1 Call by reference Type reference (TYPE) ANY 20061008
2 Importing IV_FIELD10 Call by reference Type reference (TYPE) ANY 20061008
3 Importing IV_FIELD2 Call by reference Type reference (TYPE) ANY 20061008
4 Importing IV_FIELD3 Call by reference Type reference (TYPE) ANY 20061008
5 Importing IV_FIELD4 Call by reference Type reference (TYPE) ANY 20061008
6 Importing IV_FIELD5 Call by reference Type reference (TYPE) ANY 20061008
7 Importing IV_FIELD6 Call by reference Type reference (TYPE) ANY 20061008
8 Importing IV_FIELD7 Call by reference Type reference (TYPE) ANY 20061008
9 Importing IV_FIELD8 Call by reference Type reference (TYPE) ANY 20061008
10 Importing IV_FIELD9 Call by reference Type reference (TYPE) ANY 20061008
11 Importing IV_TABLE_NAME Call by reference Type reference (TYPE) RSTABLE-TABNAME Table name 20061008
12 Returning RV_TABLE_KEY Value transfer Type reference (TYPE) RSTABLE-VARKEY Lock key for tables 20061008
# Exception Resumable Description Created on
1 CX_ESH_CO_ENGINE ESH engine exception 20061008

Method LOCK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ER_LOCK Call by reference Object reference (TYPE REF TO) CL_ESH_CO_LOCK Lock on a database table 20061008
2 Importing IV_ADD_CLIENT Call by reference Type reference (TYPE) ABAP_BOOL Add client to the lock argument 20100810
3 Importing IV_ANY_KEY Call by reference Type reference (TYPE) ANY 20070404
4 Importing IV_LOCK_MODE Call by reference Type reference (TYPE) DD26E-ENQMODE Lock mode 20061008
5 Importing IV_SCOPE Call by reference Type reference (TYPE) DDENQSCOPE '2' Control lock behavior when calling the update task 20070404
6 Importing IV_TABLE_KEY Value transfer Type reference (TYPE) RSTABLE-VARKEY Lock key for tables 20061008
7 Importing IV_TABLE_NAME Value transfer Type reference (TYPE) RSTABLE-TABNAME Table name 20061008
8 Importing IV_TRY_X_TIMES Call by reference Type reference (TYPE) I 1 Lock retries 20061008
# Exception Resumable Description Created on
1 CX_ESH_CO_ENGINE Common ESH engine exception 20061008
2 CX_ESH_CO_LOCKED ESH locking exception 20061008

Method UNLOCK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SCOPE Call by reference Type reference (TYPE) DDENQSCOPE '3' Control lock behavior when calling the update task 20070404

Method UNLOCK on class CL_ESH_CO_LOCK has no exception.

Method UNLOCK_LIST 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) ESH_T_CO_LOCKS Locks 20070612

Method UNLOCK_LIST on class CL_ESH_CO_LOCK has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in