Content Engine Java API: CmAuditDispositionPolicy

All Superinterfaces:

EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable
```
public interface CmAuditDispositionPolicy
extends RepositoryObject, Replicable, Subscribable, IndependentlyPersistableObject
```
Defines the criteria in which audit records are identified for disposition (deletion). A CmAuditDispositionPolicy is specified at the object store level, and is applied by the audit disposition thread, configured with CmAuditingConfiguration. Dispostion uses an audit disposition policy in conjunction with the object store's bookmark objects (CmAuditProcessingBookmark ). Disposition is executed by a Content Engine instance that is local to the target object store.
The criteria for selecting audit records for deletion is specified in a disposition rule. For example, criteria for deleting update events after three months is a rule. A disposition rule is expressed as the where clause of a query expression.

CmAuditDispositionPolicy is an independently persistable object, specifying one disposition rule. You can create or retrieve an CmAuditDispositionPolicy object with a Factory method. You can create more than one CmAuditDispositionPolicy object, and more than one associated schedule (configured with CmAuditingConfiguration).

For more information, see Audit Disposition.

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: Replicable

Method Summary

Methods
Modifier and Type	Method and Description
`ActiveMarkingList`	`get_ActiveMarkings()` Returns the value of the ActiveMarkings property.
`EventSet`	`get_AuditedEvents()` Returns the value of the AuditedEvents property.
`java.lang.Integer`	`get_CompletionWaitInterval()` Returns the value of the CompletionWaitInterval property.
`java.lang.String`	`get_Creator()` Returns the value of the Creator property.
`java.util.Date`	`get_DateCreated()` Returns the value of the DateCreated property.
`java.util.Date`	`get_DateLastModified()` Returns the value of the DateLastModified property.
`java.lang.String`	`get_DisplayName()` Returns the value of the DisplayName property.
`java.lang.String`	`get_DispositionRule()` Returns the value of the DispositionRule property.
`Id`	`get_Id()` Returns the value of the Id property.
`java.lang.Boolean`	`get_IsEnabled()` Returns the value of the IsEnabled property.
`java.lang.String`	`get_LastModifier()` Returns the value of the LastModifier property.
`java.lang.String`	`get_Name()` Returns the value of the Name property.
`java.lang.String`	`get_Owner()` Returns the value of the Owner property.
`AccessPermissionList`	`get_Permissions()` Returns the value of the Permissions property.
`void`	`set_CompletionWaitInterval(java.lang.Integer value)` Sets the value of the CompletionWaitInterval property.
`void`	`set_Creator(java.lang.String value)` Sets the value of the Creator property.
`void`	`set_DateCreated(java.util.Date value)` Sets the value of the DateCreated property.
`void`	`set_DateLastModified(java.util.Date value)` Sets the value of the DateLastModified property.
`void`	`set_DisplayName(java.lang.String value)` Sets the value of the DisplayName property.
`void`	`set_DispositionRule(java.lang.String value)` Sets the value of the DispositionRule property.
`void`	`set_IsEnabled(java.lang.Boolean value)` Sets the value of the IsEnabled property.
`void`	`set_LastModifier(java.lang.String value)` Sets the value of the LastModifier property.
`void`	`set_Owner(java.lang.String value)` Sets the value of the Owner property.
`void`	`set_Permissions(AccessPermissionList value)` Sets the value of the Permissions property.

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

Methods inherited from interface com.filenet.api.replication.Replicable
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup

Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

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

- Method Detail
  - get_Creator
```
java.lang.String get_Creator()
```
    Returns the value of the Creator property. For more information, see Creator Property.
  - set_Creator
```
void set_Creator(java.lang.String value)
```
    Sets the value of the Creator property. For more information, see Creator Property.
  - get_DateCreated
```
java.util.Date get_DateCreated()
```
    Returns the value of the DateCreated property. For more information, see DateCreated Property.
  - set_DateCreated
```
void set_DateCreated(java.util.Date value)
```
    Sets the value of the DateCreated property. For more information, see DateCreated Property.
  - get_LastModifier
```
java.lang.String get_LastModifier()
```
    Returns the value of the LastModifier property. For more information, see LastModifier Property.
  - set_LastModifier
```
void set_LastModifier(java.lang.String value)
```
    Sets the value of the LastModifier property. For more information, see LastModifier Property.
  - get_DateLastModified
```
java.util.Date get_DateLastModified()
```
    Returns the value of the DateLastModified property. For more information, see DateLastModified Property.
  - set_DateLastModified
```
void set_DateLastModified(java.util.Date value)
```
    Sets the value of the DateLastModified property. For more information, see DateLastModified Property.
  - get_Id
```
Id get_Id()
```
    Returns the value of the Id property. For more information, see Id Property.
  - get_Name
```
java.lang.String get_Name()
```
    Returns the value of the Name property. For more information, see Name Property.
  - get_AuditedEvents
```
EventSet get_AuditedEvents()
```
    Returns the value of the AuditedEvents property. For more information, see AuditedEvents Property.
  - get_Owner
```
java.lang.String get_Owner()
```
    Returns the value of the Owner property. For more information, see Owner Property.
  - set_Owner
```
void set_Owner(java.lang.String value)
```
    Sets the value of the Owner property. For more information, see Owner Property.
  - get_Permissions
```
AccessPermissionList get_Permissions()
```
    Returns the value of the Permissions property. For more information, see Permissions Property.
  - set_Permissions
```
void set_Permissions(AccessPermissionList value)
```
    Sets the value of the Permissions property. For more information, see Permissions Property.
  - get_ActiveMarkings
```
ActiveMarkingList get_ActiveMarkings()
```
    Returns the value of the ActiveMarkings property. For more information, see ActiveMarkings 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.
  - get_DispositionRule
```
java.lang.String get_DispositionRule()
```
    Returns the value of the DispositionRule property. For more information, see DispositionRule Property.
  - set_DispositionRule
```
void set_DispositionRule(java.lang.String value)
```
    Sets the value of the DispositionRule property. For more information, see DispositionRule Property.
  - get_CompletionWaitInterval
```
java.lang.Integer get_CompletionWaitInterval()
```
    Returns the value of the CompletionWaitInterval property. For more information, see CompletionWaitInterval Property.
  - set_CompletionWaitInterval
```
void set_CompletionWaitInterval(java.lang.Integer value)
```
    Sets the value of the CompletionWaitInterval property. For more information, see CompletionWaitInterval Property.

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

Methods inherited from interface com.filenet.api.replication.Replicable

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

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

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

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

get_Creator

set_Creator

get_DateCreated

set_DateCreated

get_LastModifier

set_LastModifier

get_DateLastModified

set_DateLastModified

get_Id

get_Name

get_AuditedEvents

get_Owner

set_Owner

get_Permissions

set_Permissions

get_ActiveMarkings

get_DisplayName

set_DisplayName

get_IsEnabled

set_IsEnabled

get_DispositionRule

set_DispositionRule

get_CompletionWaitInterval

set_CompletionWaitInterval