com.filenet.api.sweep

Interface CmContentMigrationPolicy

All Superinterfaces:

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

public interface CmContentMigrationPolicy
extends RepositoryObject, CmSweepPolicy

Represents a background task that moves content from one storage area to another. CmContentMigrationPolicy operates continuously, periodically sweeping over Document or Annotation instances, and applying the specified storage policy to all instances that meet the criteria set in the filter expression. This allows content migration policies to be used, for example, to implement a hierarchical storage management (HSM) mechanism, where content is moved progressively to lower cost, higher latency storage as it ages, or to distribute content to different storage areas based on a changing property value.

CmContentMigrationPolicy can also be used to disable replication on federated documents and annotations after the content has been moved to a P8 storage area.

CmContentMigrationPolicy offers the same functionality as CmBulkMoveContentJob, except that CmBulkMoveContentJob makes a single pass over instances of the Document or Annotation target class or subclass.

When you create a CmContentMigrationPolicy object, the server automatically creates the other objects required for policy-based processing: CmSweepPolicyRelationship and CmPolicyControlledSweep. A CmContentMigrationPolicy 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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	get_EndReplicationAfterMove() Returns the value of the EndReplicationAfterMove property.
StoragePolicy	get_StoragePolicy() Returns the value of the StoragePolicy property.
void	set_EndReplicationAfterMove(java.lang.Boolean value) Sets the value of the EndReplicationAfterMove property.
void	set_StoragePolicy(StoragePolicy value) Sets the value of the StoragePolicy property.

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_StoragePolicy

StoragePolicy get_StoragePolicy()

Returns the value of the StoragePolicy property. For more information, see StoragePolicy Property.

set_StoragePolicy

void set_StoragePolicy(StoragePolicy value)

Sets the value of the StoragePolicy property. For more information, see StoragePolicy Property.

get_EndReplicationAfterMove

java.lang.Boolean get_EndReplicationAfterMove()

Returns the value of the EndReplicationAfterMove property. For more information, see EndReplicationAfterMove Property.

set_EndReplicationAfterMove

void set_EndReplicationAfterMove(java.lang.Boolean value)

Sets the value of the EndReplicationAfterMove property. For more information, see EndReplicationAfterMove Property.