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

Enum DocumentSearchCustomization

java.lang.Object

java.lang.Enum<DocumentSearchCustomization>

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

All Implemented Interfaces:

Serializable, Comparable<DocumentSearchCustomization>

public enum DocumentSearchCustomization
extends Enum<DocumentSearchCustomization>

An enumeration which defines the set of available document search customizations.

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLEAR_CRITERIA Customization of clearing of the document search criteria.
CRITERIA Customization of the document search criteria.
RESULT_SET_FIELDS Customization of the document search result attribute fields.
RESULTS Customization of document search results.

Method Summary

Methods

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

CRITERIA

public static final DocumentSearchCustomization CRITERIA

Customization of the document search criteria.

CLEAR_CRITERIA

public static final DocumentSearchCustomization CLEAR_CRITERIA

Customization of clearing of the document search criteria.

RESULTS

public static final DocumentSearchCustomization RESULTS

Customization of document search results.

RESULT_SET_FIELDS

public static final DocumentSearchCustomization RESULT_SET_FIELDS

Customization of the document search result attribute fields.

Method Detail

values

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

Returns:

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

valueOf

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