public interface CmPolicyControlledSweep extends RepositoryObject, CmSweep
CmSweepPolicy
object.
The same instance of a policy controlled sweep is subscribed to by all sweep policy objects that target classes whose instances are contained in the same table. If the policy controlled sweep does not already exist for a particular table, the server creates it.
For example, consider a scenario where two sweep policies are created that target Document subclasses DC1 and DC2. Instances of Document subclasses are persisted in the DocVersion table. In this scenario, there currently is no policy controlled sweep instance for the DocVersion table. When a disposal policy is created with a sweep target of DC1, the server creates a policy controlled sweep to visit the DocVersion table for instances of class DC1. When a retention update policy is created with a sweep target of DC2, the server uses the existing policy controlled sweep, which is now configured to sweep over the DocVersion table for instances of both DC1 and DC2.
When a sweep policy object is created, the server automatically creates a
CmSweepRelationship
object that links the sweep policy object with an instance of the policy controlled sweep.
In the previous example, two CmSweepRelationship
objects
are created, one that associates the disposal policy object to the policy controlled sweep instance
for the DocVersion table, and one that associates the retention update policy object to
the same policy controlled sweep object.
Modifier and Type | Method and Description |
---|---|
java.lang.Integer |
get_CompletedIterations()
Returns the value of the CompletedIterations property.
|
java.lang.Double |
get_CurrentExaminedObjectCount()
Returns the value of the CurrentExaminedObjectCount property.
|
java.lang.Double |
get_CurrentFailedObjectCount()
Returns the value of the CurrentFailedObjectCount property.
|
java.lang.Double |
get_CurrentProcessedObjectCount()
Returns the value of the CurrentProcessedObjectCount property.
|
java.lang.Integer |
get_FilteredQueryTimeout()
Returns the value of the FilteredQueryTimeout property.
|
java.lang.Integer |
get_InterSweepDelay()
Returns the value of the InterSweepDelay property.
|
java.util.Date |
get_NextStartTime()
Returns the value of the NextStartTime property.
|
CmSweepRelationshipSet |
get_SweepSubscribers()
Returns the value of the SweepSubscribers property.
|
void |
set_FilteredQueryTimeout(java.lang.Integer value)
Sets the value of the FilteredQueryTimeout property.
|
void |
set_InterSweepDelay(java.lang.Integer value)
Sets the value of the InterSweepDelay property.
|
get_AuditedEvents, get_Creator, get_DateCreated, get_DateLastModified, get_ExaminedObjectCount, get_FailedObjectCount, get_Id, get_InterBatchDelay, get_LastModifier, get_MaxSweepWorkers, get_Owner, get_Permissions, get_ProcessedObjectCount, get_SweepEndDate, get_SweepStartDate, get_SweepTarget, get_SweepTimeslots, set_Creator, set_DateCreated, set_DateLastModified, set_InterBatchDelay, set_LastModifier, set_MaxSweepWorkers, set_Owner, set_Permissions, set_SweepTarget, set_SweepTimeslots
getObjectStore
raiseEvent
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
CmSweepRelationshipSet get_SweepSubscribers()
java.lang.Integer get_InterSweepDelay()
void set_InterSweepDelay(java.lang.Integer value)
java.util.Date get_NextStartTime()
java.lang.Double get_CurrentExaminedObjectCount()
java.lang.Double get_CurrentProcessedObjectCount()
java.lang.Double get_CurrentFailedObjectCount()
java.lang.Integer get_CompletedIterations()
java.lang.Integer get_FilteredQueryTimeout()
void set_FilteredQueryTimeout(java.lang.Integer value)
© Copyright IBM Corporation 2006, 2015. All rights reserved.