xdev.ui.locking

Interface LockSupport

All Known Implementing Classes:

PessimisticLockSupport

public interface LockSupport

The basic lock functionality provider for Lockable implementations.

Since:

4.0

Author:

XDEV Software jwill

Method Summary

Modifier and Type	Method and Description
void	initiateLocking(VirtualTable.VirtualTableRow row, Lockable lockable) Initiates the lock process considering the applied PessimisticLockStrategy.
boolean	isNotLocked(VirtualTable.VirtualTableRow record, Lockable lockable) Informs about the lock state of a particular record.
void	releaseLock(VirtualTable.VirtualTableRow row, Lockable lockable) Releases an existing lock for the concerned VirtualTable.VirtualTableRow.

Method Detail

initiateLocking

void initiateLocking(VirtualTable.VirtualTableRow row,
                     Lockable lockable)
              throws RowAlreadyLockedException,
                     LockingException

Initiates the lock process considering the applied PessimisticLockStrategy.

Parameters:

row - the record which shall be locked.

lockable - the lockable implementation.

Throws:

RowAlreadyLockedException - exception information about conflicting lock requests.

LockingException - exception information about an error within the lock process.

See Also:

Lockable.getLockStrategy()

releaseLock

void releaseLock(VirtualTable.VirtualTableRow row,
                 Lockable lockable)
          throws LockingException

Releases an existing lock for the concerned VirtualTable.VirtualTableRow.

Parameters:

row - the record which shall be locked.

lockable - the lockable implementation.

Throws:

LockingException - exception information about an error within the lock process.

isNotLocked

boolean isNotLocked(VirtualTable.VirtualTableRow record,
                    Lockable lockable)
             throws LockingException

Informs about the lock state of a particular record.

Parameters:

record - the record to get the lock state from.

lockable - the lockable implementation.

Returns:

the indicator whether the concerned record is already locked.

Throws:

LockingException - exception information about an error within the lock process.