DocumentStatus (Rice 2.5.10 API)

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

All Implemented Interfaces:

Serializable, Comparable<DocumentStatus>, Coded
```
public enum DocumentStatus
extends Enum<DocumentStatus>
implements Coded
```
An enumeration representing valid workflow document statuses.

Author:

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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CANCELED`
`DISAPPROVED`
`ENROUTE`
`EXCEPTION`
`FINAL`
`INITIATED`
`PROCESSED`
`RECALLED` When invoked, RECALL & CANCEL action will perform the RECALL and set the route status of the document to the new, terminal status of RECALLED
`SAVED`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DocumentStatus`	`fromCode(String code)`
`DocumentStatusCategory`	`getCategory()`
`String`	`getCode()` The code value for this object.
`String`	`getLabel()`
`static EnumSet<DocumentStatus>`	`getStatusesForCategory(DocumentStatusCategory category)`
`static DocumentStatus`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DocumentStatus[]`	`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
  - 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 & 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 Detail
  - values
```
public static DocumentStatus[] 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 (DocumentStatus c : DocumentStatus.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DocumentStatus 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.
  - getCategory
```
public DocumentStatusCategory getCategory()
```
  - getLabel
```
public String getLabel()
```
  - fromCode
```
public static DocumentStatus fromCode(String code)
```
  - getStatusesForCategory
```
public static EnumSet<DocumentStatus> getStatusesForCategory(DocumentStatusCategory category)
```

Enum DocumentStatus

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INITIATED

SAVED

ENROUTE

EXCEPTION

PROCESSED

FINAL

CANCELED

DISAPPROVED

RECALLED

Method Detail

values

valueOf

getCode

getCategory

getLabel

fromCode

getStatusesForCategory