org.kuali.rice.kew.api.document
Enum DocumentStatusCategory

java.lang.Object
  java.lang.Enum<DocumentStatusCategory>
      org.kuali.rice.kew.api.document.DocumentStatusCategory

All Implemented Interfaces:

Serializable, Comparable<DocumentStatusCategory>, Coded

public enum DocumentStatusCategory
extends Enum<DocumentStatusCategory>
implements Coded

A DocumentStatusCategory is a grouping of document statuses that is searchable on the document search screen.

Author:

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

Enum Constant Summary

PENDING

SUCCESSFUL

UNSUCCESSFUL

Method Summary

static DocumentStatusCategory	fromCode(String code)
String	getCode() The code value for this object.
String	getLabel()
static DocumentStatusCategory	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocumentStatusCategory[]	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

PENDING

public static final DocumentStatusCategory PENDING

SUCCESSFUL

public static final DocumentStatusCategory SUCCESSFUL

UNSUCCESSFUL

public static final DocumentStatusCategory UNSUCCESSFUL

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public String getCode()

Description copied from interface: Coded

The code value for this object. In general a code value cannot be null or a blank string.

Specified by:

getCode in interface Coded

Returns:

the code value for this object.

getLabel

public String getLabel()

fromCode

public static DocumentStatusCategory fromCode(String code)