com.filenet.api.constants
Class ObjectStateRecordingLevel

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

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

Specifies the audit recording level of the source object for an event of type ObjectChangeEvent.

See Also:
Serialized Form

Field Summary
static ObjectStateRecordingLevel MODIFIED_OBJECT
          Specifies that only the modified, post-event object is recorded in the audit log.
static int MODIFIED_OBJECT_AS_INT
          An int value associated with the MODIFIED_OBJECT instance of this class.
static ObjectStateRecordingLevel NONE
          Specifies that no source objects are recorded in the audit log.
static int NONE_AS_INT
          An int value associated with the NONE instance of this class.
static ObjectStateRecordingLevel ORIGINAL_AND_MODIFIED_OBJECTS
          Specifies that both the original, pre-event object and the modified, post-event object are recorded in the audit log.
static int ORIGINAL_AND_MODIFIED_OBJECTS_AS_INT
          An int value associated with the ORIGINAL_AND_MODIFIED_OBJECTS instance of this class.
 
Method Summary
static ObjectStateRecordingLevel 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

MODIFIED_OBJECT_AS_INT

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

MODIFIED_OBJECT

public static final ObjectStateRecordingLevel MODIFIED_OBJECT
Specifies that only the modified, post-event object is recorded in the audit log. When MODIFIED_OBJECT is set, the event's OriginalObject property will be null.


ORIGINAL_AND_MODIFIED_OBJECTS_AS_INT

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

ORIGINAL_AND_MODIFIED_OBJECTS

public static final ObjectStateRecordingLevel ORIGINAL_AND_MODIFIED_OBJECTS
Specifies that both the original, pre-event object and the modified, post-event object are recorded in the audit log. This is the default value.


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 ObjectStateRecordingLevel NONE
Specifies that no source objects are recorded in the audit log.

When NONE is specified, the event's OriginalObject and SourceObject properties will be null and the event's ModifiedProperties property will be empty.

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