public interface ILockHandle
| Modifier and Type | Interface and Description |
|---|---|
static class |
ILockHandle.LockInfo
The class that describes the current state of a lock.
|
| Modifier and Type | Method and Description |
|---|---|
ILockHandle.LockInfo |
getLockInfo()
Gets the lock information for this object.
|
boolean |
refreshLock(String userId,
String sessionId)
Indicates whether the lock is still owned by the specified user and session
and updates the time of last access, extending the protection span to the default initial value.
|
boolean |
releaseLock(String userId,
String sessionId)
Releases the lock for the current object.
|
boolean |
setLock(String userId,
String sessionId,
String description)
Sets the lock for the current object.
|
boolean |
takeLock(String userId,
String sessionId,
String description)
Attempts to acquire the lock for the current object even though the object is locked for a different user or session.
|
boolean setLock(String userId, String sessionId, String description)
userId - the ID of the user, as returned from IPrincipal.getUniqueID()sessionId - an application defined parameter that could allow, for example, to distinguish between different
editor instancesdescription - a description of the locking applicationILockHandle.LockInfo getLockInfo()
boolean releaseLock(String userId, String sessionId)
userId - the ID of the user, as returned from IPrincipal.getUniqueID()sessionId - an application defined parameter that could allow for example to distinguish between different editor instancesboolean refreshLock(String userId, String sessionId)
userId - the ID of the user, as returned from IPrincipal.getUniqueID()sessionId - an application defined parameter that could allow for example to distinguish between different editor instancesboolean takeLock(String userId, String sessionId, String description)
userId - the ID of the user, as returned from IPrincipal.getUniqueID()sessionId - an application defined parameter that could allow for example to distinguish between different editor instancesdescription - a description of the locking application| Access Rights |
|---|
| SC | DC | Public Part | ACH |
|---|---|---|---|
[sap.com] EP-BASIS-API
|
[sap.com] tc/epbc/pcm/admin/public/api
|
api
|
EP-PIN
|
[sap.com] EP-RUNTIME
|
[sap.com] tc/ep/semantics/api
|
api
|
EP-PIN
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2021 SAP SE Complete Copyright Notice