Package ch.systemsx.cisd.openbis.generic.shared.basic.dto

Enum DetailedSearchFieldKind

java.lang.Object

java.lang.Enum<DetailedSearchFieldKind>

ch.systemsx.cisd.openbis.generic.shared.basic.dto.DetailedSearchFieldKind

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DetailedSearchFieldKind>

public enum DetailedSearchFieldKind
extends java.lang.Enum<DetailedSearchFieldKind>
implements java.io.Serializable

General kinds of fields that can be used in detailed text query for an entity.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANY_FIELD
ANY_PROPERTY
ATTRIBUTE
PROPERTY
REGISTRATOR

Method Summary

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

ANY_FIELD

public static final DetailedSearchFieldKind ANY_FIELD

ANY_PROPERTY

public static final DetailedSearchFieldKind ANY_PROPERTY

PROPERTY

public static final DetailedSearchFieldKind PROPERTY

ATTRIBUTE

public static final DetailedSearchFieldKind ATTRIBUTE

REGISTRATOR

public static final DetailedSearchFieldKind REGISTRATOR

Method Detail

values

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

Returns:

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

valueOf

public static DetailedSearchFieldKind valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDescription

public java.lang.String getDescription()