public interface Lockable
Modifier and Type | Method and Description |
---|---|
int |
getLockStatus(LockOwner caller)
returns the current lockstatus of the lockable - if parent is set and locked the lockstatus is inherited
|
Lockable |
getParentLockable()
returns the parent lockable of this lockable for e.g.
|
void |
lock(LockOwner owner)
locks the object for the given owner
|
void |
unlock(LockOwner owner)
unlock the object if it is locked by the given owner
this method only delegates to LockOwner.releaseLock()
|
void lock(LockOwner owner) throws WGAPIException
WGAPIException
- - instance of LockWaitTimeoutException when the lock request timed out- instance of ParentIsLockedException when the lock cannot be obtained
because the parent object is already locked
- other API Exceptions on API errors
void unlock(LockOwner owner)
owner
- - the LockOwner who has obtained the lockint getLockStatus(LockOwner caller) throws WGAPIException
caller
- - LockOwner who wants to retrieve his lockstatus for this documentWGAPIException
Lockable getParentLockable() throws WGAPIException
WGAPIException