PessimisticLock (XDEV Application Framework 6.0.2 API)

All Known Implementing Classes:

HybridVirtualTableLock
```
public interface PessimisticLock
```
A user who reads a record, with the intention of updating it, places an exclusive lock on the record to prevent other users from manipulating it. This means no one else can manipulate that record until the user releases the lock.
Provides functionality to create, renew, remove and observe a records lock.
Locks will be stored in a PessimisticLockTable which must be used to lock records and has to be created before starting the locking process.

Since:

4.0

Author:

XDEV Software (RHHF), XDEV Software jwill

See Also:

PessimisticLockTable

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addLockTimeoutListener(LockTimeoutListener listener)` Observes for the locks timeout and notification threshold.
`void`	`addLockTimeoutPropertyChangeListener(LockTimeoutChangeListener listener)` Observes for a property change on the lock timeout property.
`LockConstructionState`	`getLock()` Notifies about the lock construction state either regenerated or initially created.
`PessimisticLockInfo`	`getLockInfo()` Returns a property container which provides all relevant data about a specific lock.
`List<LockTimeoutChangeListener>`	`getLockListener()` Returns all lock timeout property change observers.
`Set<LockTimeoutListener>`	`getLockTimeoutListener()` Returns all lock time out observers.
`long`	`getRemainingTime()` Returns the remaining lock duration.
`long`	`getTimeout()` Returns the initial lock duration.
`boolean`	`isUserValid()` Indicates whether this lock is still valid.
`void`	`removeLock()` Removes the lock from its related record.
`void`	`removeLockTimeoutListener(LockTimeoutListener listener)` Stops the observation of the locks timeout and notification threshold.
`void`	`removeLockTimeoutPropertyChangeListener(LockTimeoutChangeListener listener)` Stops observing the lock timeout property.
`void`	`renewLock(long timeout)` Regenerates an existing lock for a specific time.

- Method Detail
  - getLock
```
LockConstructionState getLock()
                       throws LockingException,
                              RowAlreadyLockedException
```
    Notifies about the lock construction state either regenerated or initially created.
    
    Returns:
    
    the LockConstructionState.
    
    Throws:
    
    LockingException - which provides exception information about failures within the locking process.
    
    RowAlreadyLockedException - which notifies about requesting a lock for a conflicted record.
  - removeLock
```
void removeLock()
         throws LockingException
```
    Removes the lock from its related record.
    
    Throws:
    
    LockingException - which provides exception information about failures within the locking process.
  - renewLock
```
void renewLock(long timeout)
        throws LockingException,
               RowAlreadyLockedException
```
    Regenerates an existing lock for a specific time.
    
    Parameters:
    
    timeout - the regeneration time.
    
    Throws:
    
    LockingException - which provides exception information about failures within the locking process.
    
    RowAlreadyLockedException - which notifies about requesting a lock for a conflicted record.
  - getLockInfo
```
PessimisticLockInfo getLockInfo()
```
    Returns a property container which provides all relevant data about a specific lock.
    
    Returns:
    
    returns all relevant data about a specific lock instance.
  - isUserValid
```
boolean isUserValid()
             throws LockingException
```
    Indicates whether this lock is still valid.
    
    Returns:
    
    the existence state of the lock.
    
    Throws:
    
    LockingException - which provides exception information about failures within the locking process.
  - getTimeout
```
long getTimeout()
```
    Returns the initial lock duration.
    
    Returns:
    
    the initial lock duration.
  - getRemainingTime
```
long getRemainingTime()
               throws LockingException
```
    Returns the remaining lock duration.
    
    Returns:
    
    the remaining lock duration.
    
    Throws:
    
    LockingException - which provides exception information about failures within the locking process.
  - addLockTimeoutListener
```
void addLockTimeoutListener(LockTimeoutListener listener)
                     throws LockingException
```
    Observes for the locks timeout and notification threshold.
    
    Parameters:
    
    listener - the lock duration observer.
    
    Throws:
    
    LockingException - which provides exception information about failures within the locking process.
  - removeLockTimeoutListener
```
void removeLockTimeoutListener(LockTimeoutListener listener)
```
    Stops the observation of the locks timeout and notification threshold.
    
    Parameters:
    
    listener - the lock duration observer to remove.
  - getLockTimeoutListener
```
Set<LockTimeoutListener> getLockTimeoutListener()
```
    Returns all lock time out observers.
    
    Returns:
    
    the lock timeout observers.
  - addLockTimeoutPropertyChangeListener
```
void addLockTimeoutPropertyChangeListener(LockTimeoutChangeListener listener)
```
    Observes for a property change on the lock timeout property.
    
    Parameters:
    
    listener - the lock timeout property observer.
  - removeLockTimeoutPropertyChangeListener
```
void removeLockTimeoutPropertyChangeListener(LockTimeoutChangeListener listener)
```
    Stops observing the lock timeout property.
    
    Parameters:
    
    listener - the observer to remove.
  - getLockListener
```
List<LockTimeoutChangeListener> getLockListener()
```
    Returns all lock timeout property change observers.
    
    Returns:
    
    the lock timeout property change observers.

Interface PessimisticLock

Method Summary

Method Detail

getLock

removeLock

renewLock

getLockInfo

isUserValid

getTimeout

getRemainingTime

addLockTimeoutListener

removeLockTimeoutListener

getLockTimeoutListener

addLockTimeoutPropertyChangeListener

removeLockTimeoutPropertyChangeListener

getLockListener