com.filenet.api.constants
Class RenditionEngineState

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

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

Provides a set of constants that identify the state of the Rendition Engine connection.

See Also:
Serialized Form

Field Summary
static RenditionEngineState ENABLED
          Specifies that the Rendition Engine connection is enabled.
static int ENABLED_AS_INT
          An int value associated with the ENABLED instance of this class.
static RenditionEngineState SUSPENDED
          Specifies that the Rendition Engine connection is suspended.
static int SUSPENDED_AS_INT
          An int value associated with the SUSPENDED instance of this class.
static RenditionEngineState UNINITIALIZED
          Specifies that the Rendition Engine connection has not been initialized.
static int UNINITIALIZED_AS_INT
          An int value associated with the UNINITIALIZED instance of this class.
 
Method Summary
static RenditionEngineState 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

UNINITIALIZED_AS_INT

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

UNINITIALIZED

public static final RenditionEngineState UNINITIALIZED
Specifies that the Rendition Engine connection has not been initialized.


ENABLED_AS_INT

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

ENABLED

public static final RenditionEngineState ENABLED
Specifies that the Rendition Engine connection is enabled.


SUSPENDED_AS_INT

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

SUSPENDED

public static final RenditionEngineState SUSPENDED
Specifies that the Rendition Engine connection is suspended.

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 RenditionEngineState 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, 2008. All rights reserved.