com.filenet.api.sweep

Interface CmRetentionUpdateJob

All Superinterfaces:

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

public interface CmRetentionUpdateJob
extends RepositoryObject, CmSweepJob

Represents a background task that updates the retention date on objects that support it. A CmRetentionUpdateJob performs a one-time sweep, updating the CmRetentionDate property on all instances that meet the criteria set in the filter expression. For this type of sweep, you must set the sweep target to a Document, Folder, Annotation, or CustomObject class or subclass.

The CREATE_INSTANCE access right is required on the class definition to create a CmRetentionUpdateJob instance. The MODIFY_RETENTION access right is required on the object store to create, update, or delete instances of this class.

Metadata

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	get_AllowRetentionReduction() Returns the value of the AllowRetentionReduction property.
java.lang.String	get_BaseDatePropertyName() Returns the value of the BaseDatePropertyName property.
java.lang.Integer	get_RetentionDurationUpdate() Returns the value of the RetentionDurationUpdate property.
DurationUnits	get_RetentionPeriodUnits() Returns the value of the RetentionPeriodUnits property.
java.util.Date	get_SpecificRetentionDate() Returns the value of the SpecificRetentionDate property.
void	set_BaseDatePropertyName(java.lang.String value) Sets the value of the BaseDatePropertyName property.
void	set_RetentionDurationUpdate(java.lang.Integer value) Sets the value of the RetentionDurationUpdate property.
void	set_RetentionPeriodUnits(DurationUnits value) Sets the value of the RetentionPeriodUnits property.
void	set_SpecificRetentionDate(java.util.Date value) Sets the value of the SpecificRetentionDate property.

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_RetentionDurationUpdate

java.lang.Integer get_RetentionDurationUpdate()

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

set_RetentionDurationUpdate

void set_RetentionDurationUpdate(java.lang.Integer value)

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

get_SpecificRetentionDate

java.util.Date get_SpecificRetentionDate()

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

set_SpecificRetentionDate

void set_SpecificRetentionDate(java.util.Date value)

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

get_BaseDatePropertyName

java.lang.String get_BaseDatePropertyName()

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

set_BaseDatePropertyName

void set_BaseDatePropertyName(java.lang.String value)

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

get_RetentionPeriodUnits

DurationUnits get_RetentionPeriodUnits()

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

set_RetentionPeriodUnits

void set_RetentionPeriodUnits(DurationUnits value)

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

get_AllowRetentionReduction

java.lang.Boolean get_AllowRetentionReduction()

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