SAP ABAP Interface IF_KMC_LOCK_MGR (Manager for aspect Lock)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ EP-KM-WS (Application Component) Embedded Knowledge Management
     ⤷ S_KMC_BC_RF (Package) KMC: Repository Framework Client API

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_KMC_LOCK_MGR	Manager for aspect Lock	20050323

Properties

Interface	IF_KMC_LOCK_MGR
Short Description	Manager for aspect Lock

General Data

Package	S_KMC_BC_RF	KMC: Repository Framework Client API
Created	20050323	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

Interface IF_KMC_LOCK_MGR has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_KMC_MANAGER	☐	☐	Marker interface for all managers	20050323

Friends

Interface IF_KMC_LOCK_MGR has no friend.

Attributes

Interface IF_KMC_LOCK_MGR has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_LOCKS	Instance method	Public	Method	Get array of lock infos describing all locks set.	20050323
2	GET_LOCKS_MASS	Instance method	Public	Method	Get array of lock infos of an array of rids.	20050719
3	GET_MANAGER_FACTORY	Instance method	Public	Method	Get Manager Factory	20050323
4	LOCK	Instance method	Public	Method	Lock a resource for access according to the lock descriptor.	20050323
5	REFRESH_LOCK	Instance method	Public	Method	Refresh a lock for a resource.	20050323
6	SET_MANAGER_FACTORY	Instance method	Public	Method	Set Manager Factory	20050323
7	UNLOCK	Instance method	Public	Method	Unlock a resource based on the used lock token.	20050323

Events

Interface IF_KMC_LOCK_MGR has no event.

Types

Interface IF_KMC_LOCK_MGR has no local type.

Method Signatures

Method GET_LOCKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_LOCK_INFOS	Value transfer	☐	Type reference (TYPE)	KMC_LOCK_INFO_TAB		Array of lock infos	20050323
2	Importing	I_RID	Value transfer	☐	Type reference (TYPE)	STRING		Resource identifier	20050323

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20050323
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20050323
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20050323
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050323

Method GET_LOCKS_MASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_LOCK_INFO_BAGS	Value transfer	☐	Type reference (TYPE)	KMC_LOCK_INFO_BAG_TAB		Array of lock info bags	20050719
2	Importing	IT_RIDS	Value transfer	☐	Type reference (TYPE)	KMCWS_STRING_TAB		Array of resource identifiers	20050719

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20050719
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20050719
3	CX_KMC_INCOMPLETE_LOCKINFO_BAG	☐	Operation on multiple resources in lock info bag call failed	20050719
4	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20050719
5	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050719

Method GET_MANAGER_FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_MANAGER_FACTORY	Value transfer	☐	Object reference (TYPE REF TO)	CL_KMC_MANAGER_FACTORY		Reference to Manager Factory	20050323

Method GET_MANAGER_FACTORY on Interface IF_KMC_LOCK_MGR has no exception.

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_LOCK_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_LOCK_INFO		Lock info	20050323
2	Importing	IR_LOCK_DESCRIPTOR	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_LOCK_DESCRIPTOR		Lock descriptor	20050323
3	Importing	I_RID	Value transfer	☐	Type reference (TYPE)	STRING		Resource identifier	20050323

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20050323
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20050323
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20050323
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050323

Method REFRESH_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_LOCK_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_LOCK_INFO		Lock info	20050323
2	Importing	I_LOCK_TOKEN	Value transfer	☐	Type reference (TYPE)	STRING		Lock token	20050323
3	Importing	I_RID	Value transfer	☐	Type reference (TYPE)	STRING		Resource identifier	20050323

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20050323
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20050323
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20050323
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050323

Method SET_MANAGER_FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_MANAGER_FACTORY	Value transfer	☐	Object reference (TYPE REF TO)	CL_KMC_MANAGER_FACTORY		Reference to Manager Factory	20050323

Method SET_MANAGER_FACTORY on Interface IF_KMC_LOCK_MGR has no exception.

Method UNLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LOCK_TOKEN	Value transfer	☐	Type reference (TYPE)	STRING		Lock token	20050323
2	Importing	I_RID	Value transfer	☐	Type reference (TYPE)	STRING		Resource identifier	20050323

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20050323
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20050323
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20050323
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050323

History

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