com.filenet.api.constants
Class AuditLevel

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

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

Provides a set of constants to enable or disable auditing on an ObjectStore object.

See Also:
Serialized Form

Field Summary
static AuditLevel ENABLED
          Enables auditing on the object store.
static int ENABLED_AS_INT
          An int value associated with the ENABLED instance of this class.
static AuditLevel NONE
          Disables auditing on the object store.
static int NONE_AS_INT
          An int value associated with the NONE instance of this class.
 
Method Summary
static AuditLevel 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

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 AuditLevel ENABLED
Enables auditing on the object store.


NONE_AS_INT

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

NONE

public static final AuditLevel NONE
Disables auditing on the object store.

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 AuditLevel 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.