Content Engine Java API: CmSweep

All Superinterfaces:

EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable, Subscribable

All Known Subinterfaces:

CmBulkMoveContentJob, CmCustomQueueSweep, CmCustomSweepJob, CmPolicyControlledSweep, CmQueueSweep, CmRetentionUpdateJob, CmSweepJob, CmThumbnailGenerationJob, CmThumbnailRequestSweep
```
public interface CmSweep
extends RepositoryObject, Subscribable, IndependentlyPersistableObject
```
An abstract base class for an object that represents a background service that visits all instances of a specified class. There are three types of sweep implementations: sweep jobs, queue table sweeps, and policy-controlled sweeps. Sweep jobs run only once, whereas the other sweep types run continuously. All sweep implementations include time-based properties, and keep count of objects examined, processed, and failed.
Metadata

Auditable: true
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: false
Searchable: true
StorageType: ObjectStore
SuperclassName: Subscribable

Method Summary

Methods
Modifier and Type	Method and Description
`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.Double`	`get_ExaminedObjectCount()` Returns the value of the ExaminedObjectCount property.
`java.lang.Double`	`get_FailedObjectCount()` Returns the value of the FailedObjectCount property.
`Id`	`get_Id()` Returns the value of the Id property.
`java.lang.Integer`	`get_InterBatchDelay()` Returns the value of the InterBatchDelay property.
`java.lang.String`	`get_LastModifier()` Returns the value of the LastModifier property.
`java.lang.Integer`	`get_MaxSweepWorkers()` Returns the value of the MaxSweepWorkers property.
`java.lang.String`	`get_Owner()` Returns the value of the Owner property.
`AccessPermissionList`	`get_Permissions()` Returns the value of the Permissions property.
`java.lang.Double`	`get_ProcessedObjectCount()` Returns the value of the ProcessedObjectCount property.
`java.util.Date`	`get_SweepEndDate()` Returns the value of the SweepEndDate property.
`java.util.Date`	`get_SweepStartDate()` Returns the value of the SweepStartDate property.
`ClassDefinition`	`get_SweepTarget()` Returns the value of the SweepTarget property.
`CmTimeslotList`	`get_SweepTimeslots()` Returns the value of the SweepTimeslots 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_InterBatchDelay(java.lang.Integer value)` Sets the value of the InterBatchDelay property.
`void`	`set_LastModifier(java.lang.String value)` Sets the value of the LastModifier property.
`void`	`set_MaxSweepWorkers(java.lang.Integer value)` Sets the value of the MaxSweepWorkers 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.
`void`	`set_SweepTarget(ClassDefinition value)` Sets the value of the SweepTarget property.
`void`	`set_SweepTimeslots(CmTimeslotList value)` Sets the value of the SweepTimeslots 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_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_ExaminedObjectCount
```
java.lang.Double get_ExaminedObjectCount()
```
    Returns the value of the ExaminedObjectCount property. For more information, see ExaminedObjectCount Property.
  - get_ProcessedObjectCount
```
java.lang.Double get_ProcessedObjectCount()
```
    Returns the value of the ProcessedObjectCount property. For more information, see ProcessedObjectCount Property.
  - get_FailedObjectCount
```
java.lang.Double get_FailedObjectCount()
```
    Returns the value of the FailedObjectCount property. For more information, see FailedObjectCount Property.
  - get_SweepStartDate
```
java.util.Date get_SweepStartDate()
```
    Returns the value of the SweepStartDate property. For more information, see SweepStartDate Property.
  - get_SweepEndDate
```
java.util.Date get_SweepEndDate()
```
    Returns the value of the SweepEndDate property. For more information, see SweepEndDate Property.
  - get_MaxSweepWorkers
```
java.lang.Integer get_MaxSweepWorkers()
```
    Returns the value of the MaxSweepWorkers property. For more information, see MaxSweepWorkers Property.
  - set_MaxSweepWorkers
```
void set_MaxSweepWorkers(java.lang.Integer value)
```
    Sets the value of the MaxSweepWorkers property. For more information, see MaxSweepWorkers Property.
  - get_SweepTarget
```
ClassDefinition get_SweepTarget()
```
    Returns the value of the SweepTarget property. For more information, see SweepTarget Property.
  - set_SweepTarget
```
void set_SweepTarget(ClassDefinition value)
```
    Sets the value of the SweepTarget property. For more information, see SweepTarget Property.
  - get_SweepTimeslots
```
CmTimeslotList get_SweepTimeslots()
```
    Returns the value of the SweepTimeslots property. For more information, see SweepTimeslots Property.
  - set_SweepTimeslots
```
void set_SweepTimeslots(CmTimeslotList value)
```
    Sets the value of the SweepTimeslots property. For more information, see SweepTimeslots Property.
  - get_InterBatchDelay
```
java.lang.Integer get_InterBatchDelay()
```
    Returns the value of the InterBatchDelay property. For more information, see InterBatchDelay Property.
  - set_InterBatchDelay
```
void set_InterBatchDelay(java.lang.Integer value)
```
    Sets the value of the InterBatchDelay property. For more information, see InterBatchDelay Property.

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

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_AuditedEvents

get_Owner

set_Owner

get_Permissions

set_Permissions

get_ExaminedObjectCount

get_ProcessedObjectCount

get_FailedObjectCount

get_SweepStartDate

get_SweepEndDate

get_MaxSweepWorkers

set_MaxSweepWorkers

get_SweepTarget

set_SweepTarget

get_SweepTimeslots

set_SweepTimeslots

get_InterBatchDelay

set_InterBatchDelay