com.hcl.domino.data

Enum Document.LockMode

java.lang.Object

java.lang.Enum<Document.LockMode>

com.hcl.domino.data.Document.LockMode

All Implemented Interfaces:

Serializable, Comparable<Document.LockMode>

Enclosing interface:

Document

public static enum Document.LockMode
extends Enum<Document.LockMode>

Document locking mode

Enum Constant Summary

Enum Constants

Enum Constant and Description
Hard Hard lock can only be set if Master Locking Server is available
HardOrProvisional Try to create a hard lock; if Master Locking Server is not available, use a provisional lock
Provisional Provisional lock can be set if Master Locking Server is not available

Method Summary

Modifier and Type	Method and Description
static Document.LockMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Document.LockMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Hard

public static final Document.LockMode Hard

Hard lock can only be set if Master Locking Server is available

HardOrProvisional

public static final Document.LockMode HardOrProvisional

Try to create a hard lock; if Master Locking Server is not available, use a provisional lock

Provisional

public static final Document.LockMode Provisional

Provisional lock can be set if Master Locking Server is not available

Method Detail

values

public static Document.LockMode[] 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 (Document.LockMode c : Document.LockMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Document.LockMode 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