com.filenet.api.sweep

Interface CmBulkMoveContentJob

All Superinterfaces:

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

public interface CmBulkMoveContentJob
extends RepositoryObject, CmSweepJob

Represents a background task that moves content from one storage area to another. A CmBulkMoveContentJob performs a one-time sweep of Document or Annotation instances, and applies the specified storage policy to all instances that meet the criteria set in the filter expression. Set the sweep target to the Document or Annotation class, or a subclass of either.

After CmBulkMoveContentJob moves the content, the Content Platform Engine deletes the content from the original storage area.

CmBulkMoveContentJob can be used to disable replication on federated documents and annotations after the content has been moved to a P8 storage area. Also, for a fixed content device that you want to retire, CmBulkMoveContentJob can be used to copy content under device retention to another storage area. In this scenario, the content is not deleted from the fixed content device.

Metadata

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

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	get_CopyRetainedContent() Returns the value of the CopyRetainedContent property.
java.lang.Boolean	get_EndReplicationAfterMove() Returns the value of the EndReplicationAfterMove property.
StoragePolicy	get_StoragePolicy() Returns the value of the StoragePolicy property.
java.lang.Boolean	get_UpdateStoragePolicy() Specifies whether the move content sweep should update the storage policy of objects moved.
void	set_CopyRetainedContent(java.lang.Boolean value) Sets the value of the CopyRetainedContent 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.
void	set_UpdateStoragePolicy(java.lang.Boolean value) Specifies whether the move content sweep should update the storage policy of objects moved.

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

get_DescriptiveText, get_DisplayName, get_EffectiveEndDate, get_EffectiveStartDate, get_FilteredQueryTimeout, get_FilterExpression, get_IncludeSubclassesRequested, get_IsEnabled, get_RecordFailures, get_SweepBatchSize, get_SweepMode, get_SweepResults, get_SweepRetryWaitInterval, set_DescriptiveText, set_DisplayName, set_EffectiveEndDate, set_EffectiveStartDate, set_FilteredQueryTimeout, set_FilterExpression, set_IncludeSubclassesRequested, set_IsEnabled, set_RecordFailures, set_SweepBatchSize, set_SweepMode, set_SweepRetryWaitInterval

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

get_AuditedEvents, get_Creator, get_DateCreated, get_DateLastModified, get_ExaminedObjectCount, get_FailedObjectCount, get_Id, get_InterBatchDelay, get_LastModifier, get_MaxSweepWorkers, get_Owner, get_Permissions, get_ProcessedObjectCount, get_SweepEndDate, get_SweepStartDate, get_SweepTarget, get_SweepTimeslots, set_Creator, set_DateCreated, set_DateLastModified, set_InterBatchDelay, set_LastModifier, set_MaxSweepWorkers, set_Owner, set_Permissions, set_SweepTarget, set_SweepTimeslots

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_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.

get_CopyRetainedContent

java.lang.Boolean get_CopyRetainedContent()

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

set_CopyRetainedContent

void set_CopyRetainedContent(java.lang.Boolean value)

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

get_UpdateStoragePolicy

java.lang.Boolean get_UpdateStoragePolicy()

Specifies whether the move content sweep should update the storage policy of objects moved.

set_UpdateStoragePolicy

void set_UpdateStoragePolicy(java.lang.Boolean value)

Specifies whether the move content sweep should update the storage policy of objects moved. Settability Restrictions: None.