Content Engine Java API: AuditDefinition

All Superinterfaces:

DependentObject, EngineObject, RepositoryObject, java.io.Serializable
```
public interface AuditDefinition
extends RepositoryObject, EngineObject, DependentObject
```
Represents a definition that specifies audit-event parameters. Audit events are set on a per-class basis: use this interface to configure a SubscribableClassDefinition object or subobject for auditing. Create an AuditDefinition object for each event that you want to audit on the class.
Multiple AuditDefinition objects for the same event type can be placed on a class to allow multiple audit clients to process the same event under different conditions, as expressed in the FilterExpression property. For example, client A retrieves update event records for flood claims flagged for suspected fraudulence, while client B retrieves update event records for paid flood claims. For more information, see Configuring Multiple Audit Definitions for the Same Event.

To create an AuditDefinition object, call the createInstance method on the Factory.AuditDefinition class. Once created, set its properties, which define the event to be audited and other parameters.

For each AuditDefinition object that you create, add it to an AuditDefinitionList collection, then set the collection on the SubscribableClassDefinition object.

To retrieve AuditDefinition objects, get the AuditDefinitionList collection and iterate it.

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: ObjectStore
SuperclassName: GenericObject

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`get_AuditFailure()` Returns the value of the AuditFailure property.
`java.lang.Boolean`	`get_AuditSuccess()` Returns the value of the AuditSuccess property.
`java.lang.String`	`get_DisplayName()` Returns the value of the DisplayName property.
`EventClassDefinition`	`get_EventClass()` Returns the value of the EventClass property.
`java.lang.String`	`get_FilteredPropertyId()` Returns the value of the FilteredPropertyId property.
`java.lang.String`	`get_FilterExpression()` Returns the value of the FilterExpression property.
`Id`	`get_Id()` Returns the value of the Id property.
`java.lang.Boolean`	`get_IncludeSubclassesRequested()` Returns the value of the IncludeSubclassesRequested property.
`java.lang.Boolean`	`get_IsEnabled()` Returns the value of the IsEnabled property.
`ObjectStateRecordingLevel`	`get_ObjectStateRecordingLevel()` Returns the value of the ObjectStateRecordingLevel property.
`void`	`set_AuditFailure(java.lang.Boolean value)` Sets the value of the AuditFailure property.
`void`	`set_AuditSuccess(java.lang.Boolean value)` Sets the value of the AuditSuccess property.
`void`	`set_DisplayName(java.lang.String value)` Sets the value of the DisplayName property.
`void`	`set_EventClass(EventClassDefinition value)` Sets the value of the EventClass property.
`void`	`set_FilteredPropertyId(java.lang.String value)` Sets the value of the FilteredPropertyId property.
`void`	`set_FilterExpression(java.lang.String value)` Sets the value of the FilterExpression property.
`void`	`set_IncludeSubclassesRequested(java.lang.Boolean value)` Sets the value of the IncludeSubclassesRequested property.
`void`	`set_IsEnabled(java.lang.Boolean value)` Sets the value of the IsEnabled property.
`void`	`set_ObjectStateRecordingLevel(ObjectStateRecordingLevel value)` Sets the value of the ObjectStateRecordingLevel property.

Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore

Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

- Method Detail
  - get_Id
```
Id get_Id()
```
    Returns the value of the Id property. For more information, see Id Property.
  - get_EventClass
```
EventClassDefinition get_EventClass()
```
    Returns the value of the EventClass property. For more information, see EventClass Property.
  - set_EventClass
```
void set_EventClass(EventClassDefinition value)
```
    Sets the value of the EventClass property. For more information, see EventClass Property.
  - get_AuditSuccess
```
java.lang.Boolean get_AuditSuccess()
```
    Returns the value of the AuditSuccess property. For more information, see AuditSuccess Property.
  - set_AuditSuccess
```
void set_AuditSuccess(java.lang.Boolean value)
```
    Sets the value of the AuditSuccess property. For more information, see AuditSuccess Property.
  - get_AuditFailure
```
java.lang.Boolean get_AuditFailure()
```
    Returns the value of the AuditFailure property. For more information, see AuditFailure Property.
  - set_AuditFailure
```
void set_AuditFailure(java.lang.Boolean value)
```
    Sets the value of the AuditFailure property. For more information, see AuditFailure Property.
  - get_IncludeSubclassesRequested
```
java.lang.Boolean get_IncludeSubclassesRequested()
```
    Returns the value of the IncludeSubclassesRequested property. For more information, see IncludeSubclassesRequested Property.
  - set_IncludeSubclassesRequested
```
void set_IncludeSubclassesRequested(java.lang.Boolean value)
```
    Sets the value of the IncludeSubclassesRequested property. For more information, see IncludeSubclassesRequested Property.
  - get_ObjectStateRecordingLevel
```
ObjectStateRecordingLevel get_ObjectStateRecordingLevel()
```
    Returns the value of the ObjectStateRecordingLevel property. For more information, see ObjectStateRecordingLevel Property.
  - set_ObjectStateRecordingLevel
```
void set_ObjectStateRecordingLevel(ObjectStateRecordingLevel value)
```
    Sets the value of the ObjectStateRecordingLevel property. For more information, see ObjectStateRecordingLevel Property.
  - get_FilterExpression
```
java.lang.String get_FilterExpression()
```
    Returns the value of the FilterExpression property. For more information, see FilterExpression Property.
  - set_FilterExpression
```
void set_FilterExpression(java.lang.String value)
```
    Sets the value of the FilterExpression property. For more information, see FilterExpression Property.
  - get_FilteredPropertyId
```
java.lang.String get_FilteredPropertyId()
```
    Returns the value of the FilteredPropertyId property. For more information, see FilteredPropertyId Property.
  - set_FilteredPropertyId
```
void set_FilteredPropertyId(java.lang.String value)
```
    Sets the value of the FilteredPropertyId property. For more information, see FilteredPropertyId Property.
  - get_DisplayName
```
java.lang.String get_DisplayName()
```
    Returns the value of the DisplayName property. For more information, see DisplayName Property.
  - set_DisplayName
```
void set_DisplayName(java.lang.String value)
```
    Sets the value of the DisplayName property. For more information, see DisplayName Property.
  - get_IsEnabled
```
java.lang.Boolean get_IsEnabled()
```
    Returns the value of the IsEnabled property. For more information, see IsEnabled Property.
  - set_IsEnabled
```
void set_IsEnabled(java.lang.Boolean value)
```
    Sets the value of the IsEnabled property. For more information, see IsEnabled Property.

Methods inherited from interface com.filenet.api.core.RepositoryObject

Methods inherited from interface com.filenet.api.core.EngineObject

get_Id

get_EventClass

set_EventClass

get_AuditSuccess

set_AuditSuccess

get_AuditFailure

set_AuditFailure

get_IncludeSubclassesRequested

set_IncludeSubclassesRequested

get_ObjectStateRecordingLevel

set_ObjectStateRecordingLevel

get_FilterExpression

set_FilterExpression

get_FilteredPropertyId

set_FilteredPropertyId

get_DisplayName

set_DisplayName

get_IsEnabled

set_IsEnabled