Package com.saperion.ngc.resultset

Enum Class SearchMode

java.lang.Object

java.lang.Enum<SearchMode>

com.saperion.ngc.resultset.SearchMode

All Implemented Interfaces:

Serializable, Comparable<SearchMode>, Constable

public enum SearchMode
extends Enum<SearchMode>

Possible search modes for the ResultSetView.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CURRENT_REVISIONS	Only show current revisions of documents.
INCLUDE_DELETED	Additionally to current revisions, show deleted documents, too.
ONLY_DELETED	Only show deleted documents.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CURRENT_REVISIONS

public static final SearchMode CURRENT_REVISIONS

Only show current revisions of documents.

INCLUDE_DELETED

public static final SearchMode INCLUDE_DELETED

Additionally to current revisions, show deleted documents, too.

ONLY_DELETED

public static final SearchMode ONLY_DELETED

Only show deleted documents.

Method Details

values

public static SearchMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SearchMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null