SAP ABAP Class /BOBF/CL_FRW_LOCKING (Framework: Internal Lock Actions)

Hierarchy

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

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

Properties

Class	/BOBF/CL_FRW_LOCKING
Short Description	Framework: Internal Lock Actions
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

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

Forward declarations

Class /BOBF/CL_FRW_LOCKING 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_FRW_LOCKING has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	SC_MODE_CHECK_OPTIMISTIC	Constant	Private	☐	Type reference (TYPE)	ENQMODE	'C'	Check optimistic lock validity	20081212
2	SC_MODE_EXCLUSIVE	Constant	Private	☐	Type reference (TYPE)	ENQMODE	'E'	Exclusive Write Mode	20081212
3	SC_MODE_OPTIMISTIC	Constant	Private	☐	Type reference (TYPE)	ENQMODE	'O'	Optimitic Write Lock	20081212
4	SC_MODE_PROMOTE	Constant	Private	☐	Type reference (TYPE)	ENQMODE	'R'	Promote from "O" to "E"	20081212
5	SC_MODE_SHARED	Constant	Private	☐	Type reference (TYPE)	ENQMODE	'S'	Shared Read Mode	20081212
6	SS_LOCK	Static Attribute	Private	☐	Type reference (TYPE)	TS_LOCK			20081212
7	ST_LOCK	Static Attribute	Private	☐	Type reference (TYPE)	TT_LOCK			20081212
8	SV_DELAY_MAX	Static Attribute	Public	☑	Type reference (TYPE)	I	3	Maximum Number of Lock Attempts	20081212

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_MODE	Instance method	Private	Method	Get Lock_mode	20081212
2	LOCK	Instance method	Private	Method	Lock Node	20081212
3	MESSAGE_FOREIGN_LOCK	Instance method	Protected	Method	Sets an error message for a foreign lock	20081212
4	MESSAGE_SYSTEM_FAILURE	Instance method	Protected	Method	Sets an error message for system failure	20081212
5	UNLOCK	Instance method	Private	Method	Unlock Node	20081212

Events

Class /BOBF/CL_FRW_LOCKING has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_LOCK	Private	See coding			20081212	BEGIN OF TS_LOCK, node_key type /BOBF/OBM_NODE_KEY, bo_name TYPE /BOBF/OBM_NAME, node_name TYPE /BOBF/OBM_NAME, END OF ts_LOCK
2	TT_LOCK	Private	See coding			20081212	TT_LOCK TYPE HASHED TABLE OF TS_LOCK WITH UNIQUE KEY node_key

Method Signatures

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_FRW_LOCKING has no exception.

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_PARAMETERS	Call by reference	☐	Type reference (TYPE)	/BOBF/S_FRW_LOCK_PARAMETERS		Parameters for Lock/Unlock Action	20081212
6	Importing	IT_LOCK_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_LOCK_KEY		Lock Key (Root; Node)	20081212

Method LOCK on class /BOBF/CL_FRW_LOCKING 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_FRW_LOCKING 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_FRW_LOCKING 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_PARAMETERS	Call by reference	☐	Type reference (TYPE)	/BOBF/S_FRW_LOCK_PARAMETERS			20081212
5	Importing	IT_LOCK_KEY	Call by reference	☐	Type reference (TYPE)	/BOBF/T_FRW_LOCK_KEY			20081212

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

History

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