Content Engine Java API: ReservationType

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

All Implemented Interfaces:

java.io.Serializable
```
public final class ReservationType
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that specify the type of reservation created for a checked-out document.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static ReservationType`	`COLLABORATIVE` Specifies a collaborative reservation, which is a reservation that any user with the appropriate permissions can check in, modify, or delete.
`static int`	`COLLABORATIVE_AS_INT` An `int` value associated with the COLLABORATIVE instance of this class.
`static ReservationType`	`EXCLUSIVE` Specifies an exclusive reservation.
`static int`	`EXCLUSIVE_AS_INT` An `int` value associated with the EXCLUSIVE instance of this class.
`static ReservationType`	`OBJECT_STORE_DEFAULT` Specifies that the reservation type is the same as the default reservation type for the object store, which is specified by the DefaultReservationType property.
`static int`	`OBJECT_STORE_DEFAULT_AS_INT` An `int` value associated with the OBJECT_STORE_DEFAULT instance of this class.
`static ReservationType`	`REPLICATED` This constant is not supported.
`static int`	`REPLICATED_AS_INT` An `int` value associated with the REPLICATED instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static ReservationType`	`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
  - OBJECT_STORE_DEFAULT_AS_INT
```
public static final int OBJECT_STORE_DEFAULT_AS_INT
```
    An int value associated with the OBJECT_STORE_DEFAULT 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
  - OBJECT_STORE_DEFAULT
```
public static final ReservationType OBJECT_STORE_DEFAULT
```
    Specifies that the reservation type is the same as the default reservation type for the object store, which is specified by the DefaultReservationType property.
  - EXCLUSIVE_AS_INT
```
public static final int EXCLUSIVE_AS_INT
```
    An int value associated with the EXCLUSIVE 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
  - EXCLUSIVE
```
public static final ReservationType EXCLUSIVE
```
    Specifies an exclusive reservation. For this type of reservation, only the user who checked out the document can check it in. This user and a user with Full Control access can delete the reservation.
  - COLLABORATIVE_AS_INT
```
public static final int COLLABORATIVE_AS_INT
```
    An int value associated with the COLLABORATIVE 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
  - COLLABORATIVE
```
public static final ReservationType COLLABORATIVE
```
    Specifies a collaborative reservation, which is a reservation that any user with the appropriate permissions can check in, modify, or delete.
  - REPLICATED_AS_INT
```
public static final int REPLICATED_AS_INT
```
    An int value associated with the REPLICATED 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
  - REPLICATED
```
public static final ReservationType REPLICATED
```
    This constant is not supported.
- 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 ReservationType 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

OBJECT_STORE_DEFAULT_AS_INT

OBJECT_STORE_DEFAULT

EXCLUSIVE_AS_INT

EXCLUSIVE

COLLABORATIVE_AS_INT

COLLABORATIVE

REPLICATED_AS_INT

REPLICATED

getValue

toString

getInstanceFromInt