com.saperion.rmi

Enum SaQueryInfo.IndexState

java.lang.Object

java.lang.Enum<SaQueryInfo.IndexState>

com.saperion.rmi.SaQueryInfo.IndexState

All Implemented Interfaces:

Serializable, Comparable<SaQueryInfo.IndexState>

Enclosing class:

SaQueryInfo

public static enum SaQueryInfo.IndexState
extends Enum<SaQueryInfo.IndexState>

Index states of documents that can be included in a query-result.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELETED Indexstate of a document that is deleted.
NORMAL Indexstate of a document that is the latest revision and is not deleted.
REVISED Indexstate of any old revision of a document that is not deleted.

Method Summary

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

NORMAL

public static final SaQueryInfo.IndexState NORMAL

Indexstate of a document that is the latest revision and is not deleted.

REVISED

public static final SaQueryInfo.IndexState REVISED

Indexstate of any old revision of a document that is not deleted.

DELETED

public static final SaQueryInfo.IndexState DELETED

Indexstate of a document that is deleted.

Method Detail

values

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

Returns:

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

valueOf

public static SaQueryInfo.IndexState 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