Content Engine Java API: CmSweepPolicy

All Superinterfaces:

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

All Known Subinterfaces:

CmContentMigrationPolicy, CmCustomSweepPolicy, CmDisposalPolicy, CmRetentionUpdatePolicy
```
public interface CmSweepPolicy
extends RepositoryObject, Replicable, Subscribable, IndependentlyPersistableObject
```
Abstract base class for objects that specify rules for a policy controlled sweep, represented by a CmPolicyControlledSweep object.
Metadata

Auditable: true
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: Replicable

Method Summary

Methods
Modifier and Type	Method and Description
`EventSet`	`get_AuditedEvents()` Returns the value of the AuditedEvents property.
`java.lang.Integer`	`get_CompletedIterations()` Returns the value of the CompletedIterations property.
`java.lang.String`	`get_Creator()` Returns the value of the Creator 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.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_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.Double`	`get_ExaminedObjectCount()` Returns the value of the ExaminedObjectCount property.
`java.lang.Double`	`get_FailedObjectCount()` Returns the value of the FailedObjectCount property.
`java.lang.String`	`get_FilterExpression()` Returns the value of the FilterExpression property.
`Id`	`get_Id()` Returns the value of the Id 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.String`	`get_LastModifier()` Returns the value of the LastModifier 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.
`SweepMode`	`get_SweepMode()` Returns the value of the SweepMode property.
`java.lang.Integer`	`get_SweepResultIterationKeepCount()` Returns the value of the SweepResultIterationKeepCount property.
`CmPolicySweepResultSet`	`get_SweepResults()` Returns the value of the SweepResults property.
`CmSweepPolicyRelationshipSet`	`get_SweepSubscriptions()` Returns the value of the SweepSubscriptions property.
`ClassDefinition`	`get_SweepTarget()` Returns the value of the SweepTarget 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_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_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_LastModifier(java.lang.String value)` Sets the value of the LastModifier 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_SweepMode(SweepMode value)` Sets the value of the SweepMode property.
`void`	`set_SweepResultIterationKeepCount(java.lang.Integer value)` Sets the value of the SweepResultIterationKeepCount property.
`void`	`set_SweepTarget(ClassDefinition value)` Sets the value of the SweepTarget property.

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

Methods inherited from interface com.filenet.api.replication.Replicable
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup

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_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_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_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_SweepSubscriptions
```
CmSweepPolicyRelationshipSet get_SweepSubscriptions()
```
    Returns the value of the SweepSubscriptions property. For more information, see SweepSubscriptions 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_CurrentExaminedObjectCount
```
java.lang.Double get_CurrentExaminedObjectCount()
```
    Returns the value of the CurrentExaminedObjectCount property. For more information, see CurrentExaminedObjectCount Property.
  - get_CurrentProcessedObjectCount
```
java.lang.Double get_CurrentProcessedObjectCount()
```
    Returns the value of the CurrentProcessedObjectCount property. For more information, see CurrentProcessedObjectCount Property.
  - get_CurrentFailedObjectCount
```
java.lang.Double get_CurrentFailedObjectCount()
```
    Returns the value of the CurrentFailedObjectCount property. For more information, see CurrentFailedObjectCount Property.
  - get_CompletedIterations
```
java.lang.Integer get_CompletedIterations()
```
    Returns the value of the CompletedIterations property. For more information, see CompletedIterations Property.
  - get_SweepResultIterationKeepCount
```
java.lang.Integer get_SweepResultIterationKeepCount()
```
    Returns the value of the SweepResultIterationKeepCount property. For more information, see SweepResultIterationKeepCount Property.
  - set_SweepResultIterationKeepCount
```
void set_SweepResultIterationKeepCount(java.lang.Integer value)
```
    Sets the value of the SweepResultIterationKeepCount property. For more information, see SweepResultIterationKeepCount Property.
  - get_SweepResults
```
CmPolicySweepResultSet 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.

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

Methods inherited from interface com.filenet.api.replication.Replicable

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_DisplayName

set_DisplayName

get_DescriptiveText

set_DescriptiveText

get_EffectiveStartDate

set_EffectiveStartDate

get_EffectiveEndDate

set_EffectiveEndDate

get_FilterExpression

set_FilterExpression

get_SweepTarget

set_SweepTarget

get_IsEnabled

set_IsEnabled

get_IncludeSubclassesRequested

set_IncludeSubclassesRequested

get_SweepSubscriptions

get_ExaminedObjectCount

get_ProcessedObjectCount

get_FailedObjectCount

get_CurrentExaminedObjectCount

get_CurrentProcessedObjectCount

get_CurrentFailedObjectCount

get_CompletedIterations

get_SweepResultIterationKeepCount

set_SweepResultIterationKeepCount

get_SweepResults

get_SweepMode

set_SweepMode