com.filenet.api.sweep

Interface CmDisposalPolicy

All Superinterfaces:

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

public interface CmDisposalPolicy
extends RepositoryObject, CmSweepPolicy

Defines criteria for objects of a specified class to be disposed by a policy controlled sweep. When you create a CmDisposalPolicy object, the server automatically creates the other objects required for policy-based processing: CmSweepPolicyRelationship and CmPolicyControlledSweep. A CmDisposalPolicy object can be associated with only one policy controlled sweep.

Metadata

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

See Also:

Disposal Policy Concepts

Method Summary

Modifier and Type	Method and Description
SweepAuthorizationMode	get_AuthorizationMode() Specifies the manner in which sweep operations are authorized.
void	set_AuthorizationMode(SweepAuthorizationMode value) Specifies the manner in which sweep operations are authorized.

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

get_AuditedEvents, get_CompletedIterations, get_Creator, get_CurrentExaminedObjectCount, get_CurrentFailedObjectCount, get_CurrentProcessedObjectCount, get_DateCreated, get_DateLastModified, get_DescriptiveText, get_DisplayName, get_EffectiveEndDate, get_EffectiveStartDate, get_ExaminedObjectCount, get_FailedObjectCount, get_FilterExpression, get_Id, get_IncludeSubclassesRequested, get_IsEnabled, get_LastModifier, get_Owner, get_Permissions, get_ProcessedObjectCount, get_SweepMode, get_SweepResultIterationKeepCount, get_SweepResults, get_SweepSubscriptions, get_SweepTarget, set_Creator, set_DateCreated, set_DateLastModified, set_DescriptiveText, set_DisplayName, set_EffectiveEndDate, set_EffectiveStartDate, set_FilterExpression, set_IncludeSubclassesRequested, set_IsEnabled, set_LastModifier, set_Owner, set_Permissions, set_SweepMode, set_SweepResultIterationKeepCount, set_SweepTarget

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_AuthorizationMode

SweepAuthorizationMode get_AuthorizationMode()

Specifies the manner in which sweep operations are authorized.

set_AuthorizationMode

void set_AuthorizationMode(SweepAuthorizationMode value)

Specifies the manner in which sweep operations are authorized. Settability Restrictions: None.