Package org.kuali.rice.kew.api.document

Enum Class DocumentStatus

java.lang.Object

java.lang.Enum<DocumentStatus>

org.kuali.rice.kew.api.document.DocumentStatus

All Implemented Interfaces:

Serializable, Comparable<DocumentStatus>, Constable, org.kuali.rice.core.api.mo.common.Coded

public enum DocumentStatus
extends Enum<DocumentStatus>
implements org.kuali.rice.core.api.mo.common.Coded

An enumeration representing valid workflow document statuses.

Author:

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

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
CANCELED
DISAPPROVED
ENROUTE
EXCEPTION
FINAL
INITIATED
PROCESSED
RECALLED	When invoked, RECALL invalid input: '&' CANCEL action will perform the RECALL and set the route status of the document to the new, terminal status of RECALLED
SAVED

Method Summary

Modifier and Type	Method	Description
static DocumentStatus	fromCode(String code)
DocumentStatusCategory	getCategory()
String	getCode()
String	getLabel()
static EnumSet<DocumentStatus>	getStatusesForCategory(DocumentStatusCategory category)
static DocumentStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocumentStatus[]	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

INITIATED

public static final DocumentStatus INITIATED

SAVED

public static final DocumentStatus SAVED

ENROUTE

public static final DocumentStatus ENROUTE

EXCEPTION

public static final DocumentStatus EXCEPTION

PROCESSED

public static final DocumentStatus PROCESSED

FINAL

public static final DocumentStatus FINAL

CANCELED

public static final DocumentStatus CANCELED

DISAPPROVED

public static final DocumentStatus DISAPPROVED

RECALLED

public static final DocumentStatus RECALLED

When invoked, RECALL invalid input: '&' CANCEL action will perform the RECALL and set the route status of the document to the new, terminal status of RECALLED

Since:

2.1

Method Details

values

public static DocumentStatus[] 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 DocumentStatus 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

getCode

public String getCode()

Specified by:

getCode in interface org.kuali.rice.core.api.mo.common.Coded

getCategory

public DocumentStatusCategory getCategory()

getLabel

public String getLabel()

fromCode

public static DocumentStatus fromCode(String code)

getStatusesForCategory

public static EnumSet<DocumentStatus> getStatusesForCategory(DocumentStatusCategory category)