Interface CmAuditProcessingBookmark
-
- All Superinterfaces:
- EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable, Subscribable
public interface CmAuditProcessingBookmark extends RepositoryObject, Subscribable, IndependentlyPersistableObject
Represents a leave-off point in the audit log (Event table), which indicates the last record processed by an audit processing client, such as an analytics or case history application. Audit disposition uses bookmarks to determine the scope of records for deletion. All audit records that precede the last record processed by any audit processing application are eligible for deletion.An audit processing client is responsible to first create an instance of
CmAuditProcessingBookmark
, and then update that same instance as subsequent batches of records are processed. A client usesFactory
methods to create and retrieve aCmAuditProcessingBookmark
object. When it creates the object, the client sets theDisplayName
property to identify itself as the bookmark creator, and theLastProcessed
property to specify the audit sequence number of the last audit record processed. For subsequent audit processing operations, the client retrieves the object and updates theLastProcessed
property.Because there can be multiple audit processor clients, an object store can contain multiple bookmarks, retrievable with the
AuditProcessingBookmarks
property.The actual audit records to be deleted are determined by the rules of an object store's disposition policies, represented by
CmAuditDispositionPolicy
objects. Only audit records that are selected by disposition policy rules and that possess an audit sequence number less than the lowest-valued bookmark will be deleted.If an audit processing client neglects to create or update its
CmAuditProcessingBookmark
object, audit disposition will be controlled solely by theCmAuditDispositionPolicy
objects. Depending on the disposition rules defined in the objects, unprocessed audited records might get deleted prematurely.For more information, see Audit Disposition.
Metadata
-
-
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.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.Id
get_Id()
Returns the value of the Id property.java.lang.String
get_LastModifier()
Returns the value of the LastModifier property.java.lang.Double
get_LastProcessed()
Returns the value of the LastProcessed 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_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_LastModifier(java.lang.String value)
Sets the value of the LastModifier property.void
set_LastProcessed(java.lang.Double value)
Sets the value of the LastProcessed 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.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_LastProcessed
java.lang.Double get_LastProcessed()
Returns the value of the LastProcessed property. For more information, see LastProcessed Property.
-
set_LastProcessed
void set_LastProcessed(java.lang.Double value)
Sets the value of the LastProcessed property. For more information, see LastProcessed Property.
-
-