com.hcl.domino.data

Enum DBQuery

java.lang.Object

java.lang.Enum<DBQuery>

com.hcl.domino.data.DBQuery

All Implemented Interfaces:

INumberEnum<Integer>, Serializable, Comparable<DBQuery>

public enum DBQuery
extends Enum<DBQuery>
implements INumberEnum<Integer>

Flags to query Database data using DQL

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBUG produce debugging output (notes.ini setting is independent of this)
DESIGN_CATALOG_REBUILD before running the query, rebuild the design catalog
DESIGN_CATALOG_REFRESH before running the query, build/refresh the design catalog
EXPLAIN Governs producing Explain output
FT_REFRESH For the 1st FT search, update the index
NO_EXEC Explain only mode, only plan and return the explain output
NOVIEWS NSF scans only
PARSEONLY to check for syntax only - stops short of planning
VIEWREFRESH refresh all views when they are opened (default is NO_UPDATE)

Method Summary

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

NO_EXEC

public static final DBQuery NO_EXEC

Explain only mode, only plan and return the explain output

DEBUG

public static final DBQuery DEBUG

produce debugging output (notes.ini setting is independent of this)

VIEWREFRESH

public static final DBQuery VIEWREFRESH

refresh all views when they are opened (default is NO_UPDATE)

PARSEONLY

public static final DBQuery PARSEONLY

to check for syntax only - stops short of planning

EXPLAIN

public static final DBQuery EXPLAIN

Governs producing Explain output

NOVIEWS

public static final DBQuery NOVIEWS

NSF scans only

FT_REFRESH

public static final DBQuery FT_REFRESH

For the 1st FT search, update the index

DESIGN_CATALOG_REFRESH

public static final DBQuery DESIGN_CATALOG_REFRESH

before running the query, build/refresh the design catalog

DESIGN_CATALOG_REBUILD

public static final DBQuery DESIGN_CATALOG_REBUILD

before running the query, rebuild the design catalog

Method Detail

values

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

Returns:

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

valueOf

public static DBQuery 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 Integer getValue()

Specified by:

getValue in interface INumberEnum<Integer>

Returns:

the C-level value of the enum

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Integer>

Returns:

the C-level value of the enum as a long