SAP ABAP Interface IF_NWECM_LOCKING_SERVICE (ECMI: Locking Service)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ECM-ABA-COR (Application Component) ECM Core Infrastructure
     ⤷ S_NWECM_SPI (Package) Service Provider Interface for ECMI

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_NWECM_LOCKING_SERVICE_SWR	SPI Firewall implementation of locking service	20081119
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_NWECM_PLC_LOCKING_SRV	ECMI: PL Locking Service	20090511
3	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SRM_ECM_LOCKING_SERVICE	Locking Service for SRM	20090316

Properties

Interface	IF_NWECM_LOCKING_SERVICE
Short Description	ECMI: Locking Service

General Data

Package	S_NWECM_SPI	Service Provider Interface for ECMI
Created	20081117	SAP
Last changed	20110908	SAP
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

#	Interface	Abstract	Final	Description	Created on
1	IF_NWECM_SUBSERVICE	☐	☐	ECMI: Basic Connector Service Interface	20081117

Friends

Interface IF_NWECM_LOCKING_SERVICE has no friend.

Attributes

Interface IF_NWECM_LOCKING_SERVICE has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_LOCK_TOKEN	Instance method	Public	Method		20081117
2	GET_HELD_LOCKS	Instance method	Public	Method		20081117
3	GET_LOCK_TOKEN	Instance method	Public	Method		20081117
4	GET_NODE_ID	Instance method	Public	Method		20081117
5	GET_NODE_LOCKS	Instance method	Public	Method		20081120
6	GET_SESSION_LOCKS	Instance method	Public	Method		20081120
7	GET_SESSION_LOCK_TOKENS	Instance method	Public	Method		20081203
8	HOLDS_LOCK	Instance method	Public	Method		20081117
9	IS_LIVE	Instance method	Public	Method		20081117
10	IS_LOCKED	Instance method	Public	Method		20081117
11	IS_LOCKED_BY_ME	Instance method	Public	Method		20081117
12	IS_OWNED_BY_SESSION	Instance method	Public	Method		20081117
13	LOCK	Instance method	Public	Method		20081117
14	REFRESH_LIFE_TIME	Instance method	Public	Method		20081117
15	REMOVE_LOCK_TOKEN	Instance method	Public	Method		20081117
16	UNLOCK	Instance method	Public	Method		20081117
17	UNLOCK_USER_LOCKS	Instance method	Public	Method		20081117

Events

Interface IF_NWECM_LOCKING_SERVICE has no event.

Types

Interface IF_NWECM_LOCKING_SERVICE has no local type.

Method Signatures

Method ADD_LOCK_TOKEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117
2	Importing	IV_LOCK_TOKEN	Value transfer	☐	Type reference (TYPE)	STRING			20081117

#	Exception	Resumable	Description	Created on
1	CX_NWECM_ACCESS_DENIED	☐	NW ECM: Access Denied Exception	20081117
2	CX_NWECM_INVALID_STATE	☐	NW ECM: Invalid State Exception	20081117
3	CX_NWECM_LOCK	☐	NW ECM: Lock Exception	20081117
4	CX_NWECM_LOCK_NOT_FOUND	☐	NW ECM: Lock not found	20090401
5	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081117

Method GET_HELD_LOCKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_NODE_INFO		NW ECM: Connector-Specific Node Info	20081117
2	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117
3	Returning	RT_LOCK_INFOS	Value transfer	☐	Type reference (TYPE)	NWECM_T_LOCK_INFO			20081203

#	Exception	Resumable	Description	Created on
1	CX_NWECM_ACCESS_DENIED	☐	NW ECM: Access Denied Exception	20081117
2	CX_NWECM_INVALID_STATE	☐	NW ECM: Invalid State Exception	20081117
3	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081117

Method GET_LOCK_TOKEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LOCK_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_LOCK_INFO		NW ECM: Lock Info	20081117
2	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117
3	Returning	RV_LOCK_TOKEN	Value transfer	☐	Type reference (TYPE)	STRING		Lock Token	20081119

#	Exception	Resumable	Description	Created on
1	CX_NWECM_INVALID_STATE	☐	NW ECM: Invalid State Exception	20081117
2	CX_NWECM_LOCK	☐	NW ECM: Lock Exception	20081117
3	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081117

Method GET_NODE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LOCK_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_LOCK_INFO		NW ECM: Lock Info	20081117
2	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117
3	Returning	RV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING			20081117

#	Exception	Resumable	Description	Created on
1	CX_NWECM_ACCESS_DENIED	☐	NW ECM: Access Denied Exception	20081117
2	CX_NWECM_INVALID_STATE	☐	NW ECM: Invalid State Exception	20081117
3	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081117

Method GET_NODE_LOCKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_NODE_INFO		NW ECM: Connector-Specific Node Info	20081120
2	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081120
3	Returning	RT_LOCK_INFOS	Value transfer	☐	Type reference (TYPE)	NWECM_T_LOCK_INFO			20081203

#	Exception	Resumable	Description	Created on
1	CX_NWECM_ACCESS_DENIED	☐	NW ECM: Access Denied Exception	20081120
2	CX_NWECM_INVALID_STATE	☐	NW ECM: Invalid State Exception	20081120
3	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081120

Method GET_SESSION_LOCKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081120
2	Returning	RT_LOCK_INFOS	Value transfer	☐	Type reference (TYPE)	NWECM_T_LOCK_INFO			20081203

#	Exception	Resumable	Description	Created on
1	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081120

Method GET_SESSION_LOCK_TOKENS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081203
2	Returning	RT_LOCK_TOKENS	Value transfer	☐	Type reference (TYPE)	NWECM_T_STRING			20081203

#	Exception	Resumable	Description	Created on
1	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081203

Method HOLDS_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_NODE_INFO		NW ECM: Connector-Specific Node Info	20081117
2	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117
3	Returning	RV_HOLDS_LOCK	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081117

#	Exception	Resumable	Description	Created on
1	CX_NWECM_ACCESS_DENIED	☐	NW ECM: Access Denied Exception	20081117
2	CX_NWECM_INVALID_STATE	☐	NW ECM: Invalid State Exception	20081117
3	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081117

Method IS_LIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LOCK_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_LOCK_INFO		NW ECM: Lock Info	20081117
2	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117
3	Returning	RV_IS_LIVE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081117

#	Exception	Resumable	Description	Created on
1	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081118

Method IS_LOCKED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_NODE_INFO		NW ECM: Connector-Specific Node Info	20081117
2	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117
3	Returning	RV_IS_LOCKED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081117

#	Exception	Resumable	Description	Created on
1	CX_NWECM_ACCESS_DENIED	☐	NW ECM: Access Denied Exception	20081117
2	CX_NWECM_INVALID_STATE	☐	NW ECM: Invalid State Exception	20081117
3	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081117

Method IS_LOCKED_BY_ME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_NODE_INFO		NW ECM: Connector-Specific Node Info	20081117
2	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117
3	Returning	RV_IS_LOCKED_BY_ME	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081117

#	Exception	Resumable	Description	Created on
1	CX_NWECM_ACCESS_DENIED	☐	NW ECM: Access Denied Exception	20081117
2	CX_NWECM_INVALID_STATE	☐	NW ECM: Invalid State Exception	20081117
3	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081117

Method IS_OWNED_BY_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LOCK_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_LOCK_INFO		NW ECM: Lock Info	20081117
2	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117
3	Returning	RV_IS_OWNED_BY_SESSION	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081117

#	Exception	Resumable	Description	Created on
1	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081117

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LOCK_PROPERTIES	Value transfer	☐	Object reference (TYPE REF TO)	CL_NWECM_LOCK_PROPERTIES		NW ECM: Lock Properties	20081117
2	Importing	IO_NODE_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_NODE_INFO		NW ECM: Connector-Specific Node Info	20081117
3	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117
4	Returning	RO_LOCK_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_LOCK_INFO		NW ECM: Lock Info	20081117

#	Exception	Resumable	Description	Created on
1	CX_NWECM_ACCESS_DENIED	☐	NW ECM: Access Denied Exception	20081117
2	CX_NWECM_CONSTRAINT_VIOLATION	☐	NW ECM: Constraint Violation	20081117
3	CX_NWECM_INVALID_STATE	☐	NW ECM: Invalid State Exception	20081117
4	CX_NWECM_LOCK	☐	NW ECM: Lock Exception	20081117
5	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081117
6	CX_NWECM_UNSUPPORTED_OPERATION	☐	NW ECM: Unsupported Repository Operation Exception	20081117

Method REFRESH_LIFE_TIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LOCK_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_LOCK_INFO		NW ECM: Connector-Specific Node Info	20081117
2	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117
3	Importing	IV_TIME_TO_LIVE	Value transfer	☐	Type reference (TYPE)	NWECM_LONG		nwecm: kind of a long integer	20081117

#	Exception	Resumable	Description	Created on
1	CX_NWECM_ACCESS_DENIED	☐	NW ECM: Access Denied Exception	20081117
2	CX_NWECM_INVALID_STATE	☐	NW ECM: Invalid State Exception	20081117
3	CX_NWECM_LOCK	☐	NW ECM: Lock Exception	20081117
4	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081117
5	CX_NWECM_UNSUPPORTED_OPERATION	☐	NW ECM: Unsupported Repository Operation Exception	20081117

Method REMOVE_LOCK_TOKEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117
2	Importing	IV_LOCK_TOKEN	Value transfer	☐	Type reference (TYPE)	STRING			20081117
3	Returning	RV_LOCK_TOKEN_REMOVED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081203

#	Exception	Resumable	Description	Created on
1	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081117

Method UNLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_NODE_INFO		NW ECM: Connector-Specific Node Info	20081117
2	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117

#	Exception	Resumable	Description	Created on
1	CX_NWECM_ACCESS_DENIED	☐	NW ECM: Access Denied Exception	20081117
2	CX_NWECM_INVALID_STATE	☐	NW ECM: Invalid State Exception	20081117
3	CX_NWECM_LOCK	☐	NW ECM: Lock Exception	20081117
4	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081117

Method UNLOCK_USER_LOCKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_NODE_INFO		NW ECM: Connector-Specific Node Info	20081117
2	Importing	IO_SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWECM_SESSION_INFO		NW ECM: Session Info for User and Workspace Identification	20081117

#	Exception	Resumable	Description	Created on
1	CX_NWECM_ACCESS_DENIED	☐	NW ECM: Access Denied Exception	20081117
2	CX_NWECM_INVALID_STATE	☐	NW ECM: Invalid State Exception	20081117
3	CX_NWECM_LOCK	☐	NW ECM: Lock Exception	20081117
4	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081117
5	CX_NWECM_UNSUPPORTED_OPERATION	☐	NW ECM: Unsupported Repository Operation Exception	20081117

History

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