CdbLockType (NSO Java API Version 5.8.4)

Object
- Enum<CdbLockType>
- - com.tailf.cdb.CdbLockType

All Implemented Interfaces:

Serializable, Comparable<CdbLockType>
```
public enum CdbLockType
extends Enum<CdbLockType>
```
DB lock type flag for Cdb Sessions which controls locking of sessions.

LOCK_SESSION or LOCK REQUESTS are mutually exclusive and controls if the lock should be held for the complete session or for each request respectively.

LOCK_WAIT can be combined with either LOCK_SESSION or LOCK_REQUEST to control if lock requests should block and wait for lock. Default behavior is to fail if lock cannot be obtained.

LOCK_PARTIAL can be combined with LOCK_REQUEST to control the lock to hold only for the subtree from the point of access for the request. Default behavior is that the complete CDB database is locked.

Locks are combined using EnumSet for example as
```
  EnumSet eSet = EnumSet.of(CdbLockType.LOCK_REQUEST,
                                         CdbLockType.LOCK_PARTIAL,
                                         CdbLockType.LOCK_WAIT);
 
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`LOCK_PARTIAL` Controls if locks of type LOCK_REQUEST should be partial i.e.
`LOCK_REQUEST` Obtain read lock for each read request
`LOCK_SESSION` Obtain read lock for the complete session
`LOCK_WAIT` Controls in combination with one of LOCK_SESSION or LOCK_REQUEST if the call should wait instead of fail if lock is not obtained.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getValue()`
`static CdbLockType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CdbLockType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - LOCK_WAIT
```
public static final CdbLockType LOCK_WAIT
```
    Controls in combination with one of LOCK_SESSION or LOCK_REQUEST if the call should wait instead of fail if lock is not obtained. Combined using EnumSet
  - LOCK_SESSION
```
public static final CdbLockType LOCK_SESSION
```
    Obtain read lock for the complete session
  - LOCK_REQUEST
```
public static final CdbLockType LOCK_REQUEST
```
    Obtain read lock for each read request
  - LOCK_PARTIAL
```
public static final CdbLockType LOCK_PARTIAL
```
    Controls if locks of type LOCK_REQUEST should be partial i.e. only lock subtree under the point of access
- Method Detail
  - values
```
public static CdbLockType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (CdbLockType c : CdbLockType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CdbLockType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getValue
```
public int getValue()
```

Enum CdbLockType

Enum Constant Summary

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

LOCK_WAIT

LOCK_SESSION

LOCK_REQUEST

LOCK_PARTIAL

Method Detail

values

valueOf

getValue