VersionStatus

java.lang.Object
- com.filenet.api.constants.VersionStatus

All Implemented Interfaces:

java.io.Serializable
```
public final class VersionStatus
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that allow the server to specify the current version state of a document version. A document version can be an in-process (latest) minor version, a released (latest) major version, a reservation (checked-out) version, or a superseded minor or major version. These constants are returned by the VersionStatus property.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static VersionStatus`	`IN_PROCESS` Specifies that the document version is an in-process minor version.
`static int`	`IN_PROCESS_AS_INT` An `int` value associated with the IN_PROCESS instance of this class.
`static VersionStatus`	`RELEASED` Specifies that the document version is a released major version.
`static int`	`RELEASED_AS_INT` An `int` value associated with the RELEASED instance of this class.
`static VersionStatus`	`RESERVATION` Specifies that the document version is a reservation version.
`static int`	`RESERVATION_AS_INT` An `int` value associated with the RESERVATION instance of this class.
`static VersionStatus`	`SUPERSEDED` Specifies that the document version is a superseded version.
`static int`	`SUPERSEDED_AS_INT` An `int` value associated with the SUPERSEDED instance of this class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VersionStatus`	`getInstanceFromInt(int value)` Returns an instance of this class using its associated integer value.
`int`	`getValue()` Returns the internal integer value associated with a specific instance of this class.
`java.lang.String`	`toString()` Returns a `String` representation of this enumeration instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - RESERVATION_AS_INT
```
public static final int RESERVATION_AS_INT
```
    An int value associated with the RESERVATION instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    
    Constant Field Values
  - RESERVATION
```
public static final VersionStatus RESERVATION
```
    Specifies that the document version is a reservation version. This is a document version that has been checked out. Only one version at a time in a given version series can be in the RESERVATION state.
  - RELEASED_AS_INT
```
public static final int RELEASED_AS_INT
```
    An int value associated with the RELEASED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    
    Constant Field Values
  - RELEASED
```
public static final VersionStatus RELEASED
```
    Specifies that the document version is a released major version. This is a version that has been checked in and is the latest major version. Only one version at a time in a given version series can be in the RELEASED state. When a reservation version is checked in as a major version, it becomes the new released version and the previously released version becomes a superseded version.
  - SUPERSEDED_AS_INT
```
public static final int SUPERSEDED_AS_INT
```
    An int value associated with the SUPERSEDED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    
    Constant Field Values
  - SUPERSEDED
```
public static final VersionStatus SUPERSEDED
```
    Specifies that the document version is a superseded version. This is a version that is either a previously released major version or an in-process minor version that has been replaced by a later version. Note that if you check in a document reservation as a new major version, both the previously released major version of the document and the in-process minor version associated with the previously released major version will be marked as superseded.
  - IN_PROCESS_AS_INT
```
public static final int IN_PROCESS_AS_INT
```
    An int value associated with the IN_PROCESS instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    
    Constant Field Values
  - IN_PROCESS
```
public static final VersionStatus IN_PROCESS
```
    Specifies that the document version is an in-process minor version. This is a version that has been checked in and is the latest minor version. Only one version at a time in a given version series can be in the IN_PROCESS state. When a reservation version is checked in as a minor version, it becomes the new in-process version and the previous in-process version becomes a superseded version.
- Method Detail
  - getValue
```
public int getValue()
```
    Returns the internal integer value associated with a specific instance of this class.
    
    Returns:
    
    The enumeration instance's ordinal value.
    
    See Also:
    
    getInstanceFromInt(int)
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this enumeration instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The enumeration instance's description.
  - getInstanceFromInt
```
public static VersionStatus getInstanceFromInt(int value)
```
    Returns an instance of this class using its associated integer value.
    
    Parameters:
    
    value - The integer value. (See the *_AS_INT fields.)
    
    Returns:
    
    The enumeration instance with the given ordinal value.
    
    Throws:
    
    EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
    
    See Also:
    
    getValue()

Methods inherited from class java.lang.Object

RESERVATION_AS_INT

RESERVATION

RELEASED_AS_INT

RELEASED

SUPERSEDED_AS_INT

SUPERSEDED

IN_PROCESS_AS_INT

IN_PROCESS

getValue

toString

getInstanceFromInt