Content Engine Java API: CmSweepJob

All Superinterfaces:

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

All Known Subinterfaces:

CmBulkMoveContentJob, CmCustomSweepJob, CmRetentionUpdateJob, CmThumbnailGenerationJob
```
public interface CmSweepJob
extends RepositoryObject, CmSweep
```
Abstract base class for a sweep that visits each instance of the specified class exactly once.
Metadata

Auditable: true
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: CmSweep

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`get_DescriptiveText()` Returns the value of the DescriptiveText property.
`java.lang.String`	`get_DisplayName()` Returns the value of the DisplayName property.
`java.util.Date`	`get_EffectiveEndDate()` Returns the value of the EffectiveEndDate property.
`java.util.Date`	`get_EffectiveStartDate()` Returns the value of the EffectiveStartDate property.
`java.lang.Integer`	`get_FilteredQueryTimeout()` Returns the value of the FilteredQueryTimeout property.
`java.lang.String`	`get_FilterExpression()` Returns the value of the FilterExpression property.
`java.lang.Boolean`	`get_IncludeSubclassesRequested()` Returns the value of the IncludeSubclassesRequested property.
`java.lang.Boolean`	`get_IsEnabled()` Returns the value of the IsEnabled property.
`java.lang.Boolean`	`get_RecordFailures()` Returns the value of the RecordFailures property.
`java.lang.Integer`	`get_SweepBatchSize()` Returns the value of the SweepBatchSize property.
`SweepMode`	`get_SweepMode()` Returns the value of the SweepMode property.
`CmJobSweepResultSet`	`get_SweepResults()` Returns the value of the SweepResults property.
`java.lang.Integer`	`get_SweepRetryWaitInterval()` Returns the value of the SweepRetryWaitInterval property.
`void`	`set_DescriptiveText(java.lang.String value)` Sets the value of the DescriptiveText property.
`void`	`set_DisplayName(java.lang.String value)` Sets the value of the DisplayName property.
`void`	`set_EffectiveEndDate(java.util.Date value)` Sets the value of the EffectiveEndDate property.
`void`	`set_EffectiveStartDate(java.util.Date value)` Sets the value of the EffectiveStartDate property.
`void`	`set_FilteredQueryTimeout(java.lang.Integer value)` Sets the value of the FilteredQueryTimeout property.
`void`	`set_FilterExpression(java.lang.String value)` Sets the value of the FilterExpression property.
`void`	`set_IncludeSubclassesRequested(java.lang.Boolean value)` Sets the value of the IncludeSubclassesRequested property.
`void`	`set_IsEnabled(java.lang.Boolean value)` Sets the value of the IsEnabled property.
`void`	`set_RecordFailures(java.lang.Boolean value)` Sets the value of the RecordFailures property.
`void`	`set_SweepBatchSize(java.lang.Integer value)` Sets the value of the SweepBatchSize property.
`void`	`set_SweepMode(SweepMode value)` Sets the value of the SweepMode property.
`void`	`set_SweepRetryWaitInterval(java.lang.Integer value)` Sets the value of the SweepRetryWaitInterval 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_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_DescriptiveText
```
java.lang.String get_DescriptiveText()
```
    Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.
  - set_DescriptiveText
```
void set_DescriptiveText(java.lang.String value)
```
    Sets the value of the DescriptiveText property. For more information, see DescriptiveText Property.
  - get_EffectiveStartDate
```
java.util.Date get_EffectiveStartDate()
```
    Returns the value of the EffectiveStartDate property. For more information, see EffectiveStartDate Property.
  - set_EffectiveStartDate
```
void set_EffectiveStartDate(java.util.Date value)
```
    Sets the value of the EffectiveStartDate property. For more information, see EffectiveStartDate Property.
  - get_EffectiveEndDate
```
java.util.Date get_EffectiveEndDate()
```
    Returns the value of the EffectiveEndDate property. For more information, see EffectiveEndDate Property.
  - set_EffectiveEndDate
```
void set_EffectiveEndDate(java.util.Date value)
```
    Sets the value of the EffectiveEndDate property. For more information, see EffectiveEndDate Property.
  - get_FilterExpression
```
java.lang.String get_FilterExpression()
```
    Returns the value of the FilterExpression property. For more information, see FilterExpression Property.
  - set_FilterExpression
```
void set_FilterExpression(java.lang.String value)
```
    Sets the value of the FilterExpression property. For more information, see FilterExpression 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_IncludeSubclassesRequested
```
java.lang.Boolean get_IncludeSubclassesRequested()
```
    Returns the value of the IncludeSubclassesRequested property. For more information, see IncludeSubclassesRequested Property.
  - set_IncludeSubclassesRequested
```
void set_IncludeSubclassesRequested(java.lang.Boolean value)
```
    Sets the value of the IncludeSubclassesRequested property. For more information, see IncludeSubclassesRequested Property.
  - get_SweepRetryWaitInterval
```
java.lang.Integer get_SweepRetryWaitInterval()
```
    Returns the value of the SweepRetryWaitInterval property. For more information, see SweepRetryWaitInterval Property.
  - set_SweepRetryWaitInterval
```
void set_SweepRetryWaitInterval(java.lang.Integer value)
```
    Sets the value of the SweepRetryWaitInterval property. For more information, see SweepRetryWaitInterval Property.
  - get_SweepBatchSize
```
java.lang.Integer get_SweepBatchSize()
```
    Returns the value of the SweepBatchSize property. For more information, see SweepBatchSize Property.
  - set_SweepBatchSize
```
void set_SweepBatchSize(java.lang.Integer value)
```
    Sets the value of the SweepBatchSize property. For more information, see SweepBatchSize Property.
  - get_RecordFailures
```
java.lang.Boolean get_RecordFailures()
```
    Returns the value of the RecordFailures property. For more information, see RecordFailures Property.
  - set_RecordFailures
```
void set_RecordFailures(java.lang.Boolean value)
```
    Sets the value of the RecordFailures property. For more information, see RecordFailures Property.
  - get_SweepResults
```
CmJobSweepResultSet get_SweepResults()
```
    Returns the value of the SweepResults property. For more information, see SweepResults Property.
  - get_SweepMode
```
SweepMode get_SweepMode()
```
    Returns the value of the SweepMode property. For more information, see SweepMode Property.
  - set_SweepMode
```
void set_SweepMode(SweepMode value)
```
    Sets the value of the SweepMode property. For more information, see SweepMode Property.
  - get_FilteredQueryTimeout
```
java.lang.Integer get_FilteredQueryTimeout()
```
    Returns the value of the FilteredQueryTimeout property. For more information, see FilteredQueryTimeout Property.
  - set_FilteredQueryTimeout
```
void set_FilteredQueryTimeout(java.lang.Integer value)
```
    Sets the value of the FilteredQueryTimeout property. For more information, see FilteredQueryTimeout Property.

Interface CmSweepJob

Metadata

Method Summary

Methods inherited from interface com.filenet.api.sweep.CmSweep

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

Method Detail

get_DisplayName

set_DisplayName

get_DescriptiveText

set_DescriptiveText

get_EffectiveStartDate

set_EffectiveStartDate

get_EffectiveEndDate

set_EffectiveEndDate

get_FilterExpression

set_FilterExpression

get_IsEnabled

set_IsEnabled

get_IncludeSubclassesRequested

set_IncludeSubclassesRequested

get_SweepRetryWaitInterval

set_SweepRetryWaitInterval

get_SweepBatchSize

set_SweepBatchSize

get_RecordFailures

set_RecordFailures

get_SweepResults

get_SweepMode

set_SweepMode

get_FilteredQueryTimeout

set_FilteredQueryTimeout