LOCK_MODE (JTDB Documentation)

java.lang.Object
- FairCom.CtreeDb.Types.LOCK_MODE

public class LOCK_MODE
extends java.lang.Object

Lock mode used on a CTBase.Lock(int) call

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FREE` Free all locks.
`static int`	`READ` Non-blocking read locks.
`static int`	`READ_BLOCK` Blocking read lock.
`static int`	`RESET` equivalent to calling Lock with LOCK_MODE.FREE followed by Lock() with LOCK_MODE.WRITE.
`static int`	`RESTORE_READ` To be used after a call to Lock with the CTLOCK_SUSPEND mode.
`static int`	`RESTORE_READ_BLOCK` To be used after a call to Lock with the CTLOCK_SUSPEND mode.
`static int`	`RESTORE_WRITE` To be used after a call to Lock with the CTLOCK_SUSPEND mode.
`static int`	`RESTORE_WRITE_BLOCK` To be used after a call to Lock with the CTLOCK_SUSPEND mode.
`static int`	`SUSPEND` Temporarily suspend locking.
`static int`	`WRITE` Non-blocking write lock.
`static int`	`WRITE_BLOCK` Blocking write lock.

Constructor Summary

Constructors
Constructor and Description

LOCK_MODE()

Constructors
Constructor and Description
`LOCK_MODE()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FREE
```
public static final int FREE
```
    Free all locks. Free the data record lock.
    
    See Also:
    
    Constant Field Values
  - READ
```
public static final int READ
```
    Non-blocking read locks. If the lock cannot be acquired an error is returned.
    
    See Also:
    
    Constant Field Values
  - READ_BLOCK
```
public static final int READ_BLOCK
```
    Blocking read lock. The thread will block until the lock can be acquired.
    
    See Also:
    
    Constant Field Values
  - WRITE
```
public static final int WRITE
```
    Non-blocking write lock. If the lock cannot be acquired an error is returned.
    
    See Also:
    
    Constant Field Values
  - WRITE_BLOCK
```
public static final int WRITE_BLOCK
```
    Blocking write lock. The thread will block until the lock can be acquired.
    
    See Also:
    
    Constant Field Values
  - RESET
```
public static final int RESET
```
    equivalent to calling Lock with LOCK_MODE.FREE followed by Lock() with LOCK_MODE.WRITE.
    
    See Also:
    
    Constant Field Values
  - SUSPEND
```
public static final int SUSPEND
```
    Temporarily suspend locking.
    
    See Also:
    
    Constant Field Values
  - RESTORE_READ
```
public static final int RESTORE_READ
```
    To be used after a call to Lock with the CTLOCK_SUSPEND mode. This lock mode restores the lock mode as READ.
    
    See Also:
    
    Constant Field Values
  - RESTORE_READ_BLOCK
```
public static final int RESTORE_READ_BLOCK
```
    To be used after a call to Lock with the CTLOCK_SUSPEND mode. This lock mode restores the lock mode as READ_BLOCK.
    
    See Also:
    
    Constant Field Values
  - RESTORE_WRITE
```
public static final int RESTORE_WRITE
```
    To be used after a call to Lock with the CTLOCK_SUSPEND mode. This lock mode restores the lock mode as WRITE.
    
    See Also:
    
    Constant Field Values
  - RESTORE_WRITE_BLOCK
```
public static final int RESTORE_WRITE_BLOCK
```
    To be used after a call to Lock with the CTLOCK_SUSPEND mode. This lock mode restores the lock mode as WRITE_BLOCK.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LOCK_MODE
```
public LOCK_MODE()
```

Class LOCK_MODE

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FREE

READ

READ_BLOCK

WRITE

WRITE_BLOCK

RESET

SUSPEND

RESTORE_READ

RESTORE_READ_BLOCK

RESTORE_WRITE

RESTORE_WRITE_BLOCK

Constructor Detail

LOCK_MODE