DocumentStatus (Alfresco 5.3.a-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<DocumentStatus>
- - org.alfresco.module.vti.metadata.dic.DocumentStatus

All Implemented Interfaces:

Serializable, Comparable<DocumentStatus>
```
public enum DocumentStatus
extends Enum<DocumentStatus>
```
Enum used to indicate document status

Author:

Dmitry Lazurkin

Enum Constant Summary

Enum Constants
Enum Constant and Description
`LONG_CHECKOUT` Document is long-term checked out and current user isn't checkout owner
`LONG_CHECKOUT_OWNER` Document is long-term checked out and current user is checkout owner
`NORMAL` Document isn't checked out and readonly
`READONLY` Document isn't checked out, but it is readonly
`SHORT_CHECKOUT` Document is short-term checked out and current user isn't checkout owner
`SHORT_CHECKOUT_OWNER` Document is short-term checked out and current user is checkout owner

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`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
  - NORMAL
```
public static final DocumentStatus NORMAL
```
    Document isn't checked out and readonly
  - READONLY
```
public static final DocumentStatus READONLY
```
    Document isn't checked out, but it is readonly
  - SHORT_CHECKOUT
```
public static final DocumentStatus SHORT_CHECKOUT
```
    Document is short-term checked out and current user isn't checkout owner
  - SHORT_CHECKOUT_OWNER
```
public static final DocumentStatus SHORT_CHECKOUT_OWNER
```
    Document is short-term checked out and current user is checkout owner
  - LONG_CHECKOUT
```
public static final DocumentStatus LONG_CHECKOUT
```
    Document is long-term checked out and current user isn't checkout owner
  - LONG_CHECKOUT_OWNER
```
public static final DocumentStatus LONG_CHECKOUT_OWNER
```
    Document is long-term checked out and current user is checkout owner
- 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

Enum DocumentStatus

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NORMAL

READONLY

SHORT_CHECKOUT

SHORT_CHECKOUT_OWNER

LONG_CHECKOUT

LONG_CHECKOUT_OWNER

Method Detail

values

valueOf