Cool documentation

com.sap.tc.col.client.generic.api
Interface ILockState


public interface ILockState

lock state of an AspectRow The three supported LockModes in Backend are SHARED (S), SHARED_PROMOTABLE (SP) and EXCLUSIVE (E).


Method Summary
 boolean hasExclusiveLock()
          returns true,true iff an exclusive lock is acquired for the AspectRow
 boolean hasExclusiveLockFailed()
          returns true, iff the last lock request failed for the AspectRow and it was an exclusive lock request
 boolean hasLock()
          returns true, iff any lock is aquired for the AspectRow
 boolean hasLockFailed()
          returns true, iff the last lock request failed for the AspectRow
 boolean hasSharedLock()
          returns true, iff a shared lock or an exclusive lock is acquired for the AspectRow.
 boolean hasSharedLockFailed()
          returns true, iff the last lock request failed for the AspectRow and it was an shared lock request.
 boolean hasSharedPromotableLock()
          returns true, iff a shared promotable lock is acquired for the AspectRow.
 boolean hasSharedPromotableLockFailed()
          returns true, iff the last lock request failed for the AspectRow and it was an shared promotable lock request
 boolean isEditable()
          returns true, iff a shared promotable lock or an exclusive lock was acquired or a shared lock was acquired with the SHARED_WITH_EXCLUSIVE_LOCK_ON_UPDATE strategy for the AspectRow, so that a client can change this AspectRow
 

Method Detail

hasLock

public boolean hasLock()
returns true, iff any lock is aquired for the AspectRow
Returns:
boolean true, iff any lock is aquired for the AspectRow

hasLockFailed

public boolean hasLockFailed()
returns true, iff the last lock request failed for the AspectRow
Returns:
boolean true, iff the last lock request failed for the AspectRow

hasExclusiveLock

public boolean hasExclusiveLock()
returns true,true iff an exclusive lock is acquired for the AspectRow
Returns:
boolean true,true iff an exclusive lock is acquired for the AspectRow

hasExclusiveLockFailed

public boolean hasExclusiveLockFailed()
returns true, iff the last lock request failed for the AspectRow and it was an exclusive lock request
Returns:
boolean true, iff the last lock request failed for the AspectRow and it was an exclusive lock request

hasSharedPromotableLock

public boolean hasSharedPromotableLock()
returns true, iff a shared promotable lock is acquired for the AspectRow.
Returns:
boolean true, iff a shared promotable lock is acquired for the AspectRow.

hasSharedPromotableLockFailed

public boolean hasSharedPromotableLockFailed()
returns true, iff the last lock request failed for the AspectRow and it was an shared promotable lock request
Returns:
boolean true, iff the last lock request failed for the AspectRow and it was an shared promotable lock request

hasSharedLock

public boolean hasSharedLock()
returns true, iff a shared lock or an exclusive lock is acquired for the AspectRow.
Returns:
boolean true, iff a shared lock or an exclusive lock is acquired for the AspectRow.

hasSharedLockFailed

public boolean hasSharedLockFailed()
returns true, iff the last lock request failed for the AspectRow and it was an shared lock request.
Returns:
boolean true, iff the last lock request failed for the AspectRow and it was an shared lock request.

isEditable

public boolean isEditable()
returns true, iff a shared promotable lock or an exclusive lock was acquired or a shared lock was acquired with the SHARED_WITH_EXCLUSIVE_LOCK_ON_UPDATE strategy for the AspectRow, so that a client can change this AspectRow
Returns:
boolean true, iff a shared promotable lock or an exclusive lock was acquired or a shared lock was acquired with the SHARED_WITH_EXCLUSIVE_LOCK_ON_UPDATE strategy for the AspectRow, so that a client can change this AspectRow

Cool documentation

Copyright © 2002 SAP AG. Automatically generated Thu Mar 3 2005, 21:55