SAP ABAP Class CL_ESH_BP_LOCK (Lock for backup)

Hierarchy

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

Properties

Class	CL_ESH_BP_LOCK
Short Description	Lock for backup
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_BACKUP	Backup
Created	20090205	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_BP_LOCK has no interface implemented.

Friends

Class CL_ESH_BP_LOCK has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	SC_APPL_CREATE_CONN	Constant	Public	☐	Type reference (TYPE)	ESH_E_BP_APPLICATION	'CREATE_CONNECTOR'	Create connector	20090209
2	SC_APPL_EXTRACTION	Constant	Public	☐	Type reference (TYPE)	ESH_E_BP_APPLICATION	'EXTRACTION'	Extraction	20090209
3	SC_APPL_EXTRACTION_PUSH	Constant	Public	☐	Type reference (TYPE)	ESH_E_BP_APPLICATION	'EXTRACTION_PUSH'	Extraction push	20090209
4	SC_APPL_IMPORT_SNOTE_PROGRAMS	Constant	Public	☐	Type reference (TYPE)	ESH_E_BP_APPLICATION	'SNOTE_IMPORT'	Import SNote programs	20110104
5	SC_APPL_RELOCATION	Constant	Public	☐	Type reference (TYPE)	ESH_E_BP_APPLICATION	'ESH_RELOCATION'	Relocation	20090219
6	SC_LOCK_OBJECT_APPLICATION	Constant	Private	☐	Type reference (TYPE)	TABNAME	'ESH_BP_APPL'	Lock object for application (used for shared appl. locks)	20090206
7	SC_LOCK_OBJECT_BACKUP	Constant	Private	☐	Type reference (TYPE)	TABNAME	'ESH_BP_BACKUP'	Lock object for backup (used for DB lock)	20090206
8	SC_LOCK_OBJECT_BACKUP_KEY	Constant	Private	☐	Type reference (TYPE)	VIM_ENQKEY	'BACKUP'	Key of 'BACKUP' object	20090206
9	SC_LOCK_OBJECT_TMP	Constant	Private	☐	Type reference (TYPE)	TABNAME	'ESH_BP_TMP'	Lock object for setting temporary locks	20090206
10	SC_LOCK_OBJECT_TMP_KEY	Constant	Private	☐	Type reference (TYPE)	VIM_ENQKEY	'GENERAL_KEY'	Key of dummy object used for setting temporary locks	20090206

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	IS_LOCKED_BY_BACKUP	Static method	Public	Method	Check whether a lock is set by backup	20090209
2	READ_DATABASE_LOCKS	Static method	Private	Method	Read lock from database	20090206
3	READ_SHARED_APPLICATION_LOCKS	Static method	Private	Method	Read shared application locks	20090206
4	REMOVE_BACKUP_LOCK	Static method	Public	Method	Do not use! Method is used by Python controller	20090205
5	REMOVE_DATABASE_LOCK	Static method	Private	Method	Remove lock in database	20090206
6	SET_APPLICATION_LOCK	Static method	Public	Method	Set application lock	20090205
7	SET_APPLICATION_LOCK_INTERNAL	Static method	Private	Method	Set application lock	20090209
8	SET_BACKUP_LOCK	Static method	Public	Method	Do not use! Method is used by Python controller	20090205
9	SET_DATABASE_LOCK	Static method	Private	Method	Set lock in database	20090206

Events

Class CL_ESH_BP_LOCK has no event.

Types

Class CL_ESH_BP_LOCK has no local type.

Method Signatures

Method IS_LOCKED_BY_BACKUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_LOCKED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090209

Method IS_LOCKED_BY_BACKUP on class CL_ESH_BP_LOCK has no exception.

Method READ_DATABASE_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)	ESH_T_BP_LOCK		Locks	20090206
2	Importing	IV_LOCK_OBJECT	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20090206
3	Importing	IV_LOCK_OBJECT_KEY	Call by reference	☐	Type reference (TYPE)	VIM_ENQKEY		Lock key for tables	20090206

Method READ_DATABASE_LOCKS on class CL_ESH_BP_LOCK has no exception.

Method READ_SHARED_APPLICATION_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)	ESH_T_BP_LOCK		Lock	20090206

#	Exception	Resumable	Description	Created on
1	CX_ESH_BP_ERROR	☐	General backup exception	20090206

Method REMOVE_BACKUP_LOCK Signature

Method REMOVE_BACKUP_LOCK on class CL_ESH_BP_LOCK has no parameter.
Method REMOVE_BACKUP_LOCK on class CL_ESH_BP_LOCK has no exception.

Method REMOVE_DATABASE_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOCK_OBJECT	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20090206
2	Importing	IV_LOCK_OBJECT_KEY	Call by reference	☐	Type reference (TYPE)	VIM_ENQKEY		Lock key for tables	20090206

Method REMOVE_DATABASE_LOCK on class CL_ESH_BP_LOCK has no exception.

Method SET_APPLICATION_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	ESH_E_BP_APPLICATION		Application which sets a shared lock	20090206
2	Importing	IV_SCOPE	Call by reference	☐	Type reference (TYPE)	DDENQSCOPE	'2'	Control lock behavior when calling the update task	20090209
3	Importing	IV_TRY_X_TIMES	Call by reference	☐	Type reference (TYPE)	I	1	Tries to get the lock	20090209
4	Returning	RR_LOCK	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_CO_LOCK		Lock on a Database Table	20090206

#	Exception	Resumable	Description	Created on
1	CX_ESH_BP_ERROR	☐	General backup exception	20090206
2	CX_ESH_BP_LOCKED	☐	Locked exception	20090206

Method SET_APPLICATION_LOCK_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	ESH_E_BP_APPLICATION		Application which sets a shared lock	20090209
2	Importing	IV_SCOPE	Call by reference	☐	Type reference (TYPE)	DDENQSCOPE	'2'	Control lock behavior when calling the update task	20090209
3	Returning	RR_LOCK	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_CO_LOCK		Lock on a Database Table	20090209

#	Exception	Resumable	Description	Created on
1	CX_ESH_BP_ERROR	☐	General backup exception	20090209
2	CX_ESH_BP_LOCKED	☐	Locked exception	20090209

Method SET_BACKUP_LOCK Signature

Method SET_BACKUP_LOCK on class CL_ESH_BP_LOCK has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_BP_ERROR	☐	General backup exception	20090206
2	CX_ESH_BP_LOCKED_BY_APPL	☐	Locked by applications	20090206

Method SET_DATABASE_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOCK_OBJECT	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20090206
2	Importing	IV_LOCK_OBJECT_KEY	Call by reference	☐	Type reference (TYPE)	VIM_ENQKEY		Lock key for tables	20090206

#	Exception	Resumable	Description	Created on
1	CX_ESH_BP_ERROR	☐	General backup exception	20090206

History

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