com.filenet.api.constants
Class ResourceStatus

java.lang.Object
  extended by com.filenet.api.constants.ResourceStatus
All Implemented Interfaces:
java.io.Serializable

public final class ResourceStatus
extends java.lang.Object
implements java.io.Serializable

Provides a set of constants that identify the availability status of a storage or index area.

See Also:
Serialized Form

Field Summary
static ResourceStatus CLOSED
          Specifies that the storage or index area is no longer accepting new content.
static int CLOSED_AS_INT
          An int value associated with the CLOSED instance of this class.
static ResourceStatus FULL
          Specifies that the storage or index area has reached its configured capacity.
static int FULL_AS_INT
          An int value associated with the FULL instance of this class.
static ResourceStatus OPEN
          Specifies that the storage or index area is accepting new content.
static int OPEN_AS_INT
          An int value associated with the OPEN instance of this class.
static ResourceStatus STANDBY
          Specifies that the storage or index area is not currently accepting new content, but may be brought into an open state.
static int STANDBY_AS_INT
          An int value associated with the STANDBY instance of this class.
static ResourceStatus UNAVAILABLE
           
static int UNAVAILABLE_AS_INT
          An int value associated with the UNAVAILABLE instance of this class.
 
Method Summary
static ResourceStatus 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

UNAVAILABLE_AS_INT

public static final int UNAVAILABLE_AS_INT
An int value associated with the UNAVAILABLE 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

UNAVAILABLE

public static final ResourceStatus UNAVAILABLE

FULL_AS_INT

public static final int FULL_AS_INT
An int value associated with the FULL 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

FULL

public static final ResourceStatus FULL
Specifies that the storage or index area has reached its configured capacity.


CLOSED_AS_INT

public static final int CLOSED_AS_INT
An int value associated with the CLOSED 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

CLOSED

public static final ResourceStatus CLOSED
Specifies that the storage or index area is no longer accepting new content.


STANDBY_AS_INT

public static final int STANDBY_AS_INT
An int value associated with the STANDBY 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

STANDBY

public static final ResourceStatus STANDBY
Specifies that the storage or index area is not currently accepting new content, but may be brought into an open state.


OPEN_AS_INT

public static final int OPEN_AS_INT
An int value associated with the OPEN 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

OPEN

public static final ResourceStatus OPEN
Specifies that the storage or index area is accepting new content.

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 ResourceStatus 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()


© Copyright IBM Corporation 2006, 2009. All rights reserved.