org.kuali.rice.kew.framework.document.search

Enum StandardResultField

java.lang.Object

java.lang.Enum<StandardResultField>

org.kuali.rice.kew.framework.document.search.StandardResultField

All Implemented Interfaces:

Serializable, Comparable<StandardResultField>

public enum StandardResultField
extends Enum<StandardResultField>

An enumeration which defines fields that are used on the document search screen and subject to customization by specific document types which configure such customizations via the document search framework.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATE_CREATED
DOCUMENT_ID
DOCUMENT_TYPE
INITIATOR
ROUTE_LOG
STATUS
TITLE

Method Summary

Modifier and Type	Method and Description
static StandardResultField	fromFieldName(String fieldName)
Set<String>	getAdditionalFieldNames() Returns additional field names that are valid and can be used to represent this standard result field as a string.
String	getStandardFieldName() Returns the standard field name of this standard result field as a string.
boolean	isFieldNameValid(String fieldName) Returns true if the given field name represents a valid field name for this standard result field.
static StandardResultField	valueOf(String name) Returns the enum constant of this type with the specified name.
static StandardResultField[]	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

DOCUMENT_ID

public static final StandardResultField DOCUMENT_ID

STATUS

public static final StandardResultField STATUS

DOCUMENT_TYPE

public static final StandardResultField DOCUMENT_TYPE

TITLE

public static final StandardResultField TITLE

INITIATOR

public static final StandardResultField INITIATOR

DATE_CREATED

public static final StandardResultField DATE_CREATED

ROUTE_LOG

public static final StandardResultField ROUTE_LOG

Method Detail

values

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

Returns:

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

valueOf

public static StandardResultField 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

getStandardFieldName

public String getStandardFieldName()

Returns the standard field name of this standard result field as a string.

Returns:

the standard result field name

getAdditionalFieldNames

public Set<String> getAdditionalFieldNames()

Returns additional field names that are valid and can be used to represent this standard result field as a string.

Returns:

a set of additional field names

isFieldNameValid

public boolean isFieldNameValid(String fieldName)

Returns true if the given field name represents a valid field name for this standard result field. The given field name is valid if it is the "standard" field name for this result field, or if it is contained withint the set of additional field names.

Parameters:

fieldName - the field name to check

Returns:

true if the field name is valid for this result field, false otherwise

fromFieldName

public static StandardResultField fromFieldName(String fieldName)