Package org.eclipse.emf.cdo.common.lock
Interface CDOLockState
- 
- All Superinterfaces:
- CDOBranchProvider,- CDOIDAndBranch,- CDOIdentifiable
 - All Known Subinterfaces:
- InternalCDOLockState
 - All Known Implementing Classes:
- AbstractCDOLockState
 
 public interface CDOLockState extends CDOIDAndBranch 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 CDOLockOwnerwhich carry that information.- Since:
- 4.1
- Author:
- Caspar De Groot
- No Implement
- This interface is not intended to be implemented by clients.
- No Extend
- This interface is not intended to be extended by clients.
 
- 
- 
Field SummaryFields Modifier and Type Field Description static intDEPTH_INFINITEstatic intDEPTH_NONE
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.ObjectgetLockedObject()Gets a unique identifier for the object that is locked; typically aCDOIDor aCDOIDAndBranch, depending on whether branching support is enabled or notjava.util.Set<CDOLockOwner>getReadLockOwners()CDOLockOwnergetWriteLockOwner()CDOLockOwnergetWriteOptionOwner()booleanisLocked(org.eclipse.net4j.util.concurrent.IRWLockManager.LockType lockType, CDOLockOwner lockOwner, boolean others)If the 'others' argument isfalse, this method returnstrueif this lock is currently held by the requesting CDOView,falseotherwise.- 
Methods inherited from interface org.eclipse.emf.cdo.common.revision.CDOIDAndBranchgetBranch
 - 
Methods inherited from interface org.eclipse.emf.cdo.common.id.CDOIdentifiablegetID
 
- 
 
- 
- 
- 
Field Detail- 
DEPTH_NONEstatic final int DEPTH_NONE - Since:
- 4.4
- See Also:
- Constant Field Values
 
 - 
DEPTH_INFINITEstatic final int DEPTH_INFINITE - Since:
- 4.4
- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getLockedObjectjava.lang.Object getLockedObject() Gets a unique identifier for the object that is locked; typically aCDOIDor aCDOIDAndBranch, depending on whether branching support is enabled or not- Returns:
- the identifier
 
 - 
isLockedboolean isLocked(org.eclipse.net4j.util.concurrent.IRWLockManager.LockType lockType, CDOLockOwner lockOwner, boolean others)If the 'others' argument isfalse, this method returnstrueif this lock is currently held by the requesting CDOView,falseotherwise.If the 'others' argument is true, this method returnstrueif this lock is currently held by another view (i.e. any view different from the requesting one),falseotherwise.
 - 
getReadLockOwnersjava.util.Set<CDOLockOwner> getReadLockOwners() 
 - 
getWriteLockOwnerCDOLockOwner getWriteLockOwner() 
 - 
getWriteOptionOwnerCDOLockOwner getWriteOptionOwner() 
 
- 
 
-