SAP ABAP Interface IF_NWECM_LOCK (ECMI: Lock Interface)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ECM-ABA-COR (Application Component) ECM Core Infrastructure
     ⤷ S_NWECM_API_ITEM (Package) ECMI: Nodes, Properties and Related Classes

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_NWECM_LOCK	Runtime implementation of Lock	20081119
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_NWECM_LOCK_AWR	API Firewall implementation of Lock	20081119

Properties

Interface	IF_NWECM_LOCK
Short Description	ECMI: Lock Interface

General Data

Package	S_NWECM_API_ITEM	ECMI: Nodes, Properties and Related Classes
Created	20081114	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 IF_NWECM_LOCK has no interface.

Friends

Interface IF_NWECM_LOCK has no friend.

Attributes

Interface IF_NWECM_LOCK has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_CLIENT_SUPPLIED_OWNER	Instance method	Public	Method	Returns the Client supplied owner	20081127
2	GET_CREATION_DATE	Instance method	Public	Method	Returns the Creation Date	20081114
3	GET_DEPTH	Instance method	Public	Method	Returns the Depth of the Lock	20081114
4	GET_LOCK_TOKEN	Instance method	Public	Method	Retunrs the lock token	20081114
5	GET_LOCK_USER	Instance method	Public	Method	Returns the Owner of the Lock	20081114
6	GET_NODE_ID	Instance method	Public	Method	Returns the node id to which the lock belongs	20081114
7	GET_SCOPE	Instance method	Public	Method	Returns the Scope of the Lock	20081114
8	GET_TIMEOUT	Instance method	Public	Method	Returns the Lock Timeout	20081114
9	GET_TYPE	Instance method	Public	Method	Returns the Type of the Lock	20081114
10	IS_LIVE	Instance method	Public	Method	Checks if the lock is still valid	20081114
11	IS_OWNED_BY_SESSION	Instance method	Public	Method	Checks if the lock belongs to the actual session	20081114
12	REFRESH_LIFE_TIME	Instance method	Public	Method	Changes the lifetime to the given value	20081114

Events

Interface IF_NWECM_LOCK has no event.

Types

Interface IF_NWECM_LOCK has no local type.

Method Signatures

Method GET_CLIENT_SUPPLIED_OWNER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CLIENT_SUPPLIED_OWNER	Value transfer	☐	Type reference (TYPE)	STRING		The client supplied owner	20081127

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

Method GET_CREATION_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CREATION_DATE	Value transfer	☐	Type reference (TYPE)	NWECM_TIMESTAMP		nwecm: Timestamp (DATS + TIMS)	20081114

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

Method GET_DEPTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_DEPTH	Value transfer	☐	Object reference (TYPE REF TO)	CL_NWECM_LOCK_DEPTH		the depth of the lock	20081202

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

Method GET_LOCK_TOKEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_LOCK_TOKEN	Value transfer	☐	Type reference (TYPE)	STRING		The lock token of the lock	20081114

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

Method GET_LOCK_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_LOCK_USER	Value transfer	☐	Type reference (TYPE)	STRING		The user who holds the lock	20081202

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

Method GET_NODE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NODE_ID	Value transfer	☐	Type reference (TYPE)	STRING		The node id to which the lock belongs	20081114

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

Method GET_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_SCOPE	Value transfer	☐	Object reference (TYPE REF TO)	CL_NWECM_LOCK_SCOPE		The scope of the lock	20081202

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

Method GET_TIMEOUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TIMEOUT	Value transfer	☐	Type reference (TYPE)	NWECM_LONG		The timeout of the lock	20081114

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

Method GET_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_TYPE	Value transfer	☐	Object reference (TYPE REF TO)	CL_NWECM_LOCK_TYPE		The type of the lock	20081202

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

Method IS_LIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IS_LIVE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Returns 'X' is the lock is still alive	20081114

#	Exception	Resumable	Description	Created on
1	CX_NWECM_INVALID_STATE	☐	NW ECM: Invalid State Exception	20081114
2	CX_NWECM_REPOSITORY	☐	NW ECM: Repository Exception	20081114

Method IS_OWNED_BY_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IS_OWNED_BY_SESSION	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Returns 'X' if the lock belongs to the acutal session	20081114

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

Method REFRESH_LIFE_TIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TIME_TO_LIVE	Value transfer	☐	Type reference (TYPE)	NWECM_LONG		The new timeout	20081114

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

History

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