com.hcl.domino

Enum DominoClient.OpenDatabase

java.lang.Object

java.lang.Enum<DominoClient.OpenDatabase>

com.hcl.domino.DominoClient.OpenDatabase

All Implemented Interfaces:

INumberEnum<Short>, Serializable, Comparable<DominoClient.OpenDatabase>

Enclosing interface:

DominoClient

public static enum DominoClient.OpenDatabase
extends Enum<DominoClient.OpenDatabase>
implements INumberEnum<Short>

Enum for options for opening the database, if the specified database is not currently available

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLUSTER_FAILOVER If open fails, failover to another server in the same cluster that has a replica copy of this database.
FIXUP Force a database fixup, even if the file was properly closed previously.
FIXUP_FULL_NOTE_SCAN Scan all notes and all items (not incremental)
FIXUP_NO_NOTE_DELETE Do not delete bad notes during note scan

Method Summary

Modifier and Type	Method and Description
long	getLongValue()
Short	getValue()
static DominoClient.OpenDatabase	valueOf(String name) Returns the enum constant of this type with the specified name.
static DominoClient.OpenDatabase[]	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

CLUSTER_FAILOVER

public static final DominoClient.OpenDatabase CLUSTER_FAILOVER

If open fails, failover to another server in the same cluster that has a replica copy of this database. If the input server is not a member of a cluster or if the database is not replicated on other servers in the cluster, then this flag will have no effect.

FIXUP

public static final DominoClient.OpenDatabase FIXUP

Force a database fixup, even if the file was properly closed previously. This flag is not necessary if the database was improperly closed, since Domino and Notes will automatically verify the database contents of improperly closed databases. This process involves three steps:
1) Perform a consistency check that compares the database's header information against the on-disk image of the database and if possible, repair any discrepancies found.
2) Perform a document by document consistency check of the entire database, that compares each note's header information against its on-disk image and if possible, repair any discrepancies found.
3) Delete all bad documents/notes that could not be corrected during the consistency check. NSFDbOpenExtended with FIXUP will not succeed if db_name specifies a directory. This flag will prevent the replicator from opening the specified database.

FIXUP_FULL_NOTE_SCAN

public static final DominoClient.OpenDatabase FIXUP_FULL_NOTE_SCAN

Scan all notes and all items (not incremental)

FIXUP_NO_NOTE_DELETE

public static final DominoClient.OpenDatabase FIXUP_NO_NOTE_DELETE

Do not delete bad notes during note scan

Method Detail

values

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

Returns:

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

valueOf

public static DominoClient.OpenDatabase 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 Short getValue()

Specified by:

getValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum as a long