org.eclipse.emf.cdo.common.lock
Interface CDOLockState

All Known Subinterfaces:

InternalCDOLockState

public interface CDOLockState

A client-side representation of all the locks on a single CDOObject.

As an individual lock is always owned by view, which in turn is owned by a session, the methods on this interface return instances of CDOLockOwner which carry that information.

Since:

4.1

No Implement

This interface is not intended to be implemented by clients.

No Extend

This interface is not intended to be extended by clients.

getLockedObject

Object getLockedObject()

Gets a unique identifier for the object that is locked; typically a CDOID or a CDOIDAndBranch, depending on whether branching support is enabled or not

Returns:

the identifier

isLocked

boolean isLocked(IRWLockManager.LockType lockType,
                 CDOLockOwner lockOwner,
                 boolean others)

If the 'others' argument is false, this method returns true if this lock is currently held by the requesting CDOView, false otherwise.

If the 'others' argument is true, this method returns true if this lock is currently held by another view (i.e. any view different from the requesting one), false otherwise.

getReadLockOwners

Set<CDOLockOwner> getReadLockOwners()

getWriteLockOwner

CDOLockOwner getWriteLockOwner()

getWriteOptionOwner

CDOLockOwner getWriteOptionOwner()