Content Engine Java API: CmAuditingConfiguration

All Superinterfaces:

DependentObject, EngineObject, java.io.Serializable, SubsystemConfiguration
```
public interface CmAuditingConfiguration
extends SubsystemConfiguration, DependentObject
```
Represents configuration data for audit disposition, a subsystem for automatic pruning (deletion) of audited events in the Content Engine audit log (Event table). Audit disposition runs as a background thread within the Content Engine.
A CmAuditingConfiguration object can be assigned to objects of the server hierarchy (Domain, Site, VirtualServer, and ServerInstance), with the first encountered by the current server being the active instance. A default instance is created at the domain level during domain creation. CmAuditingConfiguration objects are persisted in the GCD.

CmAuditingConfiguration allows admininistrative clients to set or access audit disposition configuration settings, for example, the disposition schedule and the number of audited events deleted at one time. The disposition schedule is defined through a list-of-object property called AuditDispositionTimeslots, where each element is a CmTimeslot object with properties that specify a weekday, start time, and duration.

Complementing CmAuditingConfiguration are the CmAuditDispositionPolicy class, for setting the event selection criteria (query expression) that are applied by the audit disposition thread, and CmAuditProcessingBookmark, a class with which an audit processing client can set its leave-off point in the audit log.

Audit disposition is enabled for the server or servers to which the configuration object applies when the AuditDispostionEnabled property is true and the AuditDispositionTimeslots list is non-empty. However, no disposition processing will take place for a particular object store until there is at least one enabled CmAuditDispositionPolicy object defined in that object store.

To create a CmAuditingConfiguration object, call the createInstance method on the Factory.CmAuditingConfiguration class. To instantiate a CmAuditingConfiguration object, retrieve the SubsystemConfigurations property from an object of the server hierarchy, then iterate the SubsystemConfigurationList for the CmAuditingConfiguration object.

For more information, see Audit Disposition.

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: SubsystemConfiguration

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`get_AuditDispositionBatchSize()` Returns the value of the AuditDispositionBatchSize property.
`java.lang.Boolean`	`get_AuditDispositionEnabled()` Returns the value of the AuditDispositionEnabled property.
`java.lang.Integer`	`get_AuditDispositionQuerySize()` Returns the value of the AuditDispositionQuerySize property.
`CmTimeslotList`	`get_AuditDispositionTimeslots()` Returns the value of the AuditDispositionTimeslots property.
`java.lang.Integer`	`get_AuditDispositionWaitInterval()` Returns the value of the AuditDispositionWaitInterval property.
`java.lang.Integer`	`get_LeaseDuration()` Returns the value of the LeaseDuration property.
`void`	`set_AuditDispositionBatchSize(java.lang.Integer value)` Sets the value of the AuditDispositionBatchSize property.
`void`	`set_AuditDispositionEnabled(java.lang.Boolean value)` Sets the value of the AuditDispositionEnabled property.
`void`	`set_AuditDispositionQuerySize(java.lang.Integer value)` Sets the value of the AuditDispositionQuerySize property.
`void`	`set_AuditDispositionTimeslots(CmTimeslotList value)` Sets the value of the AuditDispositionTimeslots property.
`void`	`set_AuditDispositionWaitInterval(java.lang.Integer value)` Sets the value of the AuditDispositionWaitInterval property.
`void`	`set_LeaseDuration(java.lang.Integer value)` Sets the value of the LeaseDuration property.

Methods inherited from interface com.filenet.api.admin.SubsystemConfiguration
get_Id

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

- Method Detail
  - get_AuditDispositionEnabled
```
java.lang.Boolean get_AuditDispositionEnabled()
```
    Returns the value of the AuditDispositionEnabled property. For more information, see AuditDispositionEnabled Property.
  - set_AuditDispositionEnabled
```
void set_AuditDispositionEnabled(java.lang.Boolean value)
```
    Sets the value of the AuditDispositionEnabled property. For more information, see AuditDispositionEnabled Property.
  - get_AuditDispositionWaitInterval
```
java.lang.Integer get_AuditDispositionWaitInterval()
```
    Returns the value of the AuditDispositionWaitInterval property. For more information, see AuditDispositionWaitInterval Property.
  - set_AuditDispositionWaitInterval
```
void set_AuditDispositionWaitInterval(java.lang.Integer value)
```
    Sets the value of the AuditDispositionWaitInterval property. For more information, see AuditDispositionWaitInterval Property.
  - get_AuditDispositionBatchSize
```
java.lang.Integer get_AuditDispositionBatchSize()
```
    Returns the value of the AuditDispositionBatchSize property. For more information, see AuditDispositionBatchSize Property.
  - set_AuditDispositionBatchSize
```
void set_AuditDispositionBatchSize(java.lang.Integer value)
```
    Sets the value of the AuditDispositionBatchSize property. For more information, see AuditDispositionBatchSize Property.
  - get_AuditDispositionQuerySize
```
java.lang.Integer get_AuditDispositionQuerySize()
```
    Returns the value of the AuditDispositionQuerySize property. For more information, see AuditDispositionQuerySize Property.
  - set_AuditDispositionQuerySize
```
void set_AuditDispositionQuerySize(java.lang.Integer value)
```
    Sets the value of the AuditDispositionQuerySize property. For more information, see AuditDispositionQuerySize Property.
  - get_AuditDispositionTimeslots
```
CmTimeslotList get_AuditDispositionTimeslots()
```
    Returns the value of the AuditDispositionTimeslots property. For more information, see AuditDispositionTimeslots Property.
  - set_AuditDispositionTimeslots
```
void set_AuditDispositionTimeslots(CmTimeslotList value)
```
    Sets the value of the AuditDispositionTimeslots property. For more information, see AuditDispositionTimeslots Property.
  - get_LeaseDuration
```
java.lang.Integer get_LeaseDuration()
```
    Returns the value of the LeaseDuration property. For more information, see LeaseDuration Property.
  - set_LeaseDuration
```
void set_LeaseDuration(java.lang.Integer value)
```
    Sets the value of the LeaseDuration property. For more information, see LeaseDuration Property.

Methods inherited from interface com.filenet.api.admin.SubsystemConfiguration

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

get_AuditDispositionEnabled

set_AuditDispositionEnabled

get_AuditDispositionWaitInterval

set_AuditDispositionWaitInterval

get_AuditDispositionBatchSize

set_AuditDispositionBatchSize

get_AuditDispositionQuerySize

set_AuditDispositionQuerySize

get_AuditDispositionTimeslots

set_AuditDispositionTimeslots

get_LeaseDuration

set_LeaseDuration