SAP ABAP Class /BOBF/CL_LIB_A_LOCK (Library: Lock and Unlock)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ AP-RC-BOF-RNT (Application Component) Business Object Processing Framework Runtime
     ⤷ /BOBF/LIBRARY (Package) Business Object Processing Framework Library

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	/BOBF/IF_FRW_ACTION	Interface for an Action	20081212

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/BOFU/CL_LIB_A_LOCK_BOREADONLY	Read Only BO: Always rejects lock requests	20090731
2	Inheritance (c INHERITING FROM c_ref)	/SRMERP/CL_A_LOCK	Lock and Unlock for ERP eProc BOs and their COs	20100921

Properties

Class	/BOBF/CL_LIB_A_LOCK
Short Description	Library: Lock and Unlock
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	/BOBF/LIBRARY	Business Object Processing Framework Library
Created	20081212	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /BOBF/CL_LIB_A_LOCK has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	/BOBF/IF_FRW_ACTION	☐	☐	Interface for an Action	20081212

Friends

Class /BOBF/CL_LIB_A_LOCK has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_DELAY_MAX	Constant	Private	☐	Type reference (TYPE)	I	3	Maximum Number of Lock Attempts	20081212
2	GC_MODE_CHECK_OPTIMISTIC	Constant	Private	☐	Type reference (TYPE)	ENQMODE	'C'	Check optimistic lock validity	20081212
3	GC_MODE_CHECK_PROMOTE	Constant	Private	☐	Type reference (TYPE)	ENQMODE	'C'	Check Promote	20130305
4	GC_MODE_EXCLUSIVE	Constant	Private	☐	Type reference (TYPE)	ENQMODE	'E'	Exclusive Write Mode	20081212
5	GC_MODE_OPTIMISTIC	Constant	Private	☐	Type reference (TYPE)	ENQMODE	'O'	Optimitic Write Lock	20081212
6	GC_MODE_PROMOTE	Constant	Private	☐	Type reference (TYPE)	ENQMODE	'R'	Promote from "O" to "E"	20081212
7	GC_MODE_SHARED	Constant	Private	☐	Type reference (TYPE)	ENQMODE	'S'	Shared Read Mode	20081212
8	MT_NODE	Instance attribute	Private	☐	Type reference (TYPE)	TT_NODE			20081212
9	MV_BO_NAME	Instance attribute	Private	☐	Type reference (TYPE)	/BOBF/OBM_NAME		Name	20081212
10	MV_LEVEL	Instance attribute	Private	☐	Type reference (TYPE)	INT1		Lock depth	20081212

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_KEY_LINK	Instance method	Private	Method	Build key link	20081212
2	GET_MODE	Instance method	Private	Method	Get lock mode	20081212
3	INIT_BO	Instance method	Private	Method	Initialize	20081212
4	LOCK	Instance method	Private	Method	Lock Node	20081212
5	MESSAGE_FOREIGN_LOCK	Instance method	Protected	Method	Sets an error message for a foreign lock	20081212
6	MESSAGE_SYSTEM_FAILURE	Instance method	Protected	Method	Sets an error message for system failure	20081212
7	UNLOCK	Instance method	Private	Method	Unlock Node	20081212

Events

Class /BOBF/CL_LIB_A_LOCK has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_KEY	Private	See coding			20081212	BEGIN OF ts_key, key TYPE /BOBF/CONF_KEY, key2 TYPE /BOBF/CONF_KEY, key3 TYPE /BOBF/CONF_KEY, END OF ts_key
2	TS_NODE	Private	See coding			20081212	BEGIN OF ts_node, node_key TYPE /BOBF/OBM_NODE_KEY, node_name TYPE /BOBF/OBM_NAME, level TYPE int1, navigation_path TYPE tt_path, END OF ts_node
3	TS_PATH	Private	See coding			20081212	BEGIN OF ts_path, assoc_key TYPE /BOBF/OBM_ASSOC_KEY, source_node_key TYPE /BOBF/OBM_NODE_KEY, target_node_key TYPE /BOBF/OBM_NODE_KEY, END OF ts_path
4	TT_KEY	Private	See coding			20081212	tt_key TYPE STANDARD TABLE OF ts_key WITH NON-UNIQUE DEFAULT KEY
5	TT_NODE	Private	See coding			20081212	tt_node TYPE HASHED TABLE OF ts_node WITH UNIQUE KEY node_key
6	TT_PATH	Private	See coding			20081212	tt_path TYPE STANDARD TABLE OF ts_path WITH NON-UNIQUE KEY assoc_key

Method Signatures

Method BUILD_KEY_LINK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_KEY_LINK	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY_LINK		Key Link	20081212
2	Importing	IT_KEY_LINK1	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY_LINK		Key Link	20081212
3	Importing	IT_KEY_LINK2	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY_LINK		Key Link	20081212

Method BUILD_KEY_LINK on class /BOBF/CL_LIB_A_LOCK has no exception.

Method GET_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_LOCK_MODE	Value transfer	☐	Type reference (TYPE)	ENQMODE		Lock Mode	20081212
2	Importing	IV_EDIT_MODE	Call by reference	☐	Type reference (TYPE)	/BOBF/CONF_EDIT_MODE		Changeability Mode	20081212

Method GET_MODE on class /BOBF/CL_LIB_A_LOCK has no exception.

Method INIT_BO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BO_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/OBM_BO_KEY		Business Object	20081212

#	Exception	Resumable	Description	Created on
1	/BOBF/CX_FRW	☐		20081212

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	/BOBF/IF_FRW_MESSAGE		Unlocked Entries with Lock Owners	20081212
2	Exporting	ET_FAILED_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY		Entries That Could Not Be Locked	20081212
3	Importing	IO_READ	Call by reference	☑	Object reference (TYPE REF TO)	/BOBF/IF_FRW_READ		Interface to Read Data	20081212
4	Importing	IS_CTX	Call by reference	☐	Type reference (TYPE)	/BOBF/S_FRW_CTX_ACT		Context Information for Actions	20081212
5	Importing	IS_NODE	Call by reference	☐	Type reference (TYPE)	TS_NODE		Node information	20081212
6	Importing	IS_PARAMETERS	Call by reference	☐	Type reference (TYPE)	/BOBF/S_FRW_LOCK_PARAMETERS		Parameters for Lock/Unlock Action	20081212
7	Importing	IT_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY		Key Table	20081212
8	Importing	IT_KEY_LINK1	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY_LINK		Key Link	20081212
9	Importing	IT_KEY_LINK2	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY_LINK		Key Link	20081212

Method LOCK on class /BOBF/CL_LIB_A_LOCK has no exception.

Method MESSAGE_FOREIGN_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	/BOBF/IF_FRW_MESSAGE		Interface of Message Object	20081212
2	Importing	IO_READ	Call by reference	☑	Object reference (TYPE REF TO)	/BOBF/IF_FRW_READ		Interface to Read Data	20081212
3	Importing	IS_CTX	Call by reference	☐	Type reference (TYPE)	/BOBF/S_FRW_CTX_ACT		Context Information for Actions	20081212
4	Importing	IS_LOCATION	Call by reference	☐	Type reference (TYPE)	/BOBF/S_FRW_LOCATION		Location	20081212
5	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME		User Name	20081212

Method MESSAGE_FOREIGN_LOCK on class /BOBF/CL_LIB_A_LOCK has no exception.

Method MESSAGE_SYSTEM_FAILURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	/BOBF/IF_FRW_MESSAGE		Interface of Message Object	20081212
2	Importing	IO_READ	Call by reference	☑	Object reference (TYPE REF TO)	/BOBF/IF_FRW_READ		Interface to Read Data	20081212
3	Importing	IS_CTX	Call by reference	☐	Type reference (TYPE)	/BOBF/S_FRW_CTX_ACT		Context Information for Actions	20081212
4	Importing	IS_LOCATION	Call by reference	☑	Type reference (TYPE)	/BOBF/S_FRW_LOCATION		Location	20081212

Method MESSAGE_SYSTEM_FAILURE on class /BOBF/CL_LIB_A_LOCK has no exception.

Method UNLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	/BOBF/IF_FRW_MESSAGE		Interface for Message Class	20081212
2	Importing	IO_READ	Call by reference	☑	Object reference (TYPE REF TO)	/BOBF/IF_FRW_READ		Interface to Read Data	20081212
3	Importing	IS_CTX	Call by reference	☐	Type reference (TYPE)	/BOBF/S_FRW_CTX_ACT		Context Information for Actions	20081212
4	Importing	IS_NODE	Call by reference	☐	Type reference (TYPE)	TS_NODE		Node information	20081212
5	Importing	IS_PARAMETERS	Call by reference	☐	Type reference (TYPE)	/BOBF/S_FRW_LOCK_PARAMETERS			20081212
6	Importing	IT_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY		Key Table	20081212
7	Importing	IT_KEY_LINK1	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY_LINK		Key Link	20081212
8	Importing	IT_KEY_LINK2	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_KEY_LINK		Key Link	20081212

Method UNLOCK on class /BOBF/CL_LIB_A_LOCK has no exception.

History

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