CmSweepConfiguration

All Superinterfaces:

DependentObject, EngineObject, java.io.Serializable, SubsystemConfiguration
```
public interface CmSweepConfiguration
extends SubsystemConfiguration, DependentObject
```
Represents global configuration data for the sweep framework. Sweeps run as background threads on the Content Engine.
A CmSweepConfiguration 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. CmSweepConfiguration objects are persisted in the GCD.

Metadata

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`get_BackgroundSearchLeaseDuration()` Returns the value of the BackgroundSearchLeaseDuration property.
`java.lang.Integer`	`get_DefaultDispatcherDelay()` Returns the value of the DefaultDispatcherDelay property.
`java.lang.Boolean`	`get_DispatcherEnabled()` Returns the value of the DispatcherEnabled property.
`java.lang.Integer`	`get_InterBatchDelay()` Returns the value of the InterBatchDelay property.
`java.lang.Integer`	`get_PolicyControlledSweepBatchSize()` Returns the value of the PolicyControlledSweepBatchSize property.
`java.lang.Integer`	`get_QueueSweepLeaseDuration()` Returns the value of the QueueSweepLeaseDuration property.
`java.lang.Integer`	`get_SweepJobLeaseDuration()` Returns the value of the SweepJobLeaseDuration property.
`CmTimeslotList`	`get_SweepTimeslots()` Returns the value of the SweepTimeslots property.
`java.lang.Integer`	`get_WaitForQueueActivityDelay()` Returns the value of the WaitForQueueActivityDelay property.
`java.lang.Integer`	`get_WaitForWorkersDelay()` Returns the value of the WaitForWorkersDelay property.
`java.lang.Integer`	`get_WaitForWorkersShortDelay()` Returns the value of the WaitForWorkersShortDelay property.
`void`	`set_BackgroundSearchLeaseDuration(java.lang.Integer value)` Sets the value of the BackgroundSearchLeaseDuration property.
`void`	`set_DefaultDispatcherDelay(java.lang.Integer value)` Sets the value of the DefaultDispatcherDelay property.
`void`	`set_DispatcherEnabled(java.lang.Boolean value)` Sets the value of the DispatcherEnabled property.
`void`	`set_InterBatchDelay(java.lang.Integer value)` Sets the value of the InterBatchDelay property.
`void`	`set_PolicyControlledSweepBatchSize(java.lang.Integer value)` Sets the value of the PolicyControlledSweepBatchSize property.
`void`	`set_QueueSweepLeaseDuration(java.lang.Integer value)` Sets the value of the QueueSweepLeaseDuration property.
`void`	`set_SweepJobLeaseDuration(java.lang.Integer value)` Sets the value of the SweepJobLeaseDuration property.
`void`	`set_SweepTimeslots(CmTimeslotList value)` Sets the value of the SweepTimeslots property.
`void`	`set_WaitForQueueActivityDelay(java.lang.Integer value)` Sets the value of the WaitForQueueActivityDelay property.
`void`	`set_WaitForWorkersDelay(java.lang.Integer value)` Sets the value of the WaitForWorkersDelay property.
`void`	`set_WaitForWorkersShortDelay(java.lang.Integer value)` Sets the value of the WaitForWorkersShortDelay 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_DispatcherEnabled
```
java.lang.Boolean get_DispatcherEnabled()
```
    Returns the value of the DispatcherEnabled property. For more information, see DispatcherEnabled Property.
  - set_DispatcherEnabled
```
void set_DispatcherEnabled(java.lang.Boolean value)
```
    Sets the value of the DispatcherEnabled property. For more information, see DispatcherEnabled 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_DefaultDispatcherDelay
```
java.lang.Integer get_DefaultDispatcherDelay()
```
    Returns the value of the DefaultDispatcherDelay property. For more information, see DefaultDispatcherDelay Property.
  - set_DefaultDispatcherDelay
```
void set_DefaultDispatcherDelay(java.lang.Integer value)
```
    Sets the value of the DefaultDispatcherDelay property. For more information, see DefaultDispatcherDelay Property.
  - get_PolicyControlledSweepBatchSize
```
java.lang.Integer get_PolicyControlledSweepBatchSize()
```
    Returns the value of the PolicyControlledSweepBatchSize property. For more information, see PolicyControlledSweepBatchSize Property.
  - set_PolicyControlledSweepBatchSize
```
void set_PolicyControlledSweepBatchSize(java.lang.Integer value)
```
    Sets the value of the PolicyControlledSweepBatchSize property. For more information, see PolicyControlledSweepBatchSize Property.
  - get_WaitForWorkersDelay
```
java.lang.Integer get_WaitForWorkersDelay()
```
    Returns the value of the WaitForWorkersDelay property. For more information, see WaitForWorkersDelay Property.
  - set_WaitForWorkersDelay
```
void set_WaitForWorkersDelay(java.lang.Integer value)
```
    Sets the value of the WaitForWorkersDelay property. For more information, see WaitForWorkersDelay Property.
  - get_WaitForWorkersShortDelay
```
java.lang.Integer get_WaitForWorkersShortDelay()
```
    Returns the value of the WaitForWorkersShortDelay property. For more information, see WaitForWorkersShortDelay Property.
  - set_WaitForWorkersShortDelay
```
void set_WaitForWorkersShortDelay(java.lang.Integer value)
```
    Sets the value of the WaitForWorkersShortDelay property. For more information, see WaitForWorkersShortDelay Property.
  - get_WaitForQueueActivityDelay
```
java.lang.Integer get_WaitForQueueActivityDelay()
```
    Returns the value of the WaitForQueueActivityDelay property. For more information, see WaitForQueueActivityDelay Property.
  - set_WaitForQueueActivityDelay
```
void set_WaitForQueueActivityDelay(java.lang.Integer value)
```
    Sets the value of the WaitForQueueActivityDelay property. For more information, see WaitForQueueActivityDelay Property.
  - get_SweepJobLeaseDuration
```
java.lang.Integer get_SweepJobLeaseDuration()
```
    Returns the value of the SweepJobLeaseDuration property. For more information, see SweepJobLeaseDuration Property.
  - set_SweepJobLeaseDuration
```
void set_SweepJobLeaseDuration(java.lang.Integer value)
```
    Sets the value of the SweepJobLeaseDuration property. For more information, see SweepJobLeaseDuration Property.
  - get_QueueSweepLeaseDuration
```
java.lang.Integer get_QueueSweepLeaseDuration()
```
    Returns the value of the QueueSweepLeaseDuration property. For more information, see QueueSweepLeaseDuration Property.
  - set_QueueSweepLeaseDuration
```
void set_QueueSweepLeaseDuration(java.lang.Integer value)
```
    Sets the value of the QueueSweepLeaseDuration property. For more information, see QueueSweepLeaseDuration Property.
  - get_BackgroundSearchLeaseDuration
```
java.lang.Integer get_BackgroundSearchLeaseDuration()
```
    Returns the value of the BackgroundSearchLeaseDuration property. For more information, see BackgroundSearchLeaseDuration Property.
  - set_BackgroundSearchLeaseDuration
```
void set_BackgroundSearchLeaseDuration(java.lang.Integer value)
```
    Sets the value of the BackgroundSearchLeaseDuration property. For more information, see BackgroundSearchLeaseDuration 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.admin.SubsystemConfiguration

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

get_DispatcherEnabled

set_DispatcherEnabled

get_SweepTimeslots

set_SweepTimeslots

get_DefaultDispatcherDelay

set_DefaultDispatcherDelay

get_PolicyControlledSweepBatchSize

set_PolicyControlledSweepBatchSize

get_WaitForWorkersDelay

set_WaitForWorkersDelay

get_WaitForWorkersShortDelay

set_WaitForWorkersShortDelay

get_WaitForQueueActivityDelay

set_WaitForQueueActivityDelay

get_SweepJobLeaseDuration

set_SweepJobLeaseDuration

get_QueueSweepLeaseDuration

set_QueueSweepLeaseDuration

get_BackgroundSearchLeaseDuration

set_BackgroundSearchLeaseDuration

get_InterBatchDelay

set_InterBatchDelay