com.filenet.api.sweep

Interface CmRetentionUpdatePolicy

All Superinterfaces:

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

public interface CmRetentionUpdatePolicy
extends RepositoryObject, CmSweepPolicy

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

The rules for modifying the retention date of an object selected by this sweep policy are the same rules that apply for modifying an object's retention date directly with its CmRetentionDate property. For example, this sweep policy cannot be used to update the retention date of an object if the object's CmRetentionDate property is set to PERMANENT.

The CREATE_INSTANCE access right is required on the class definition to create a CmRetentionUpdatePolicy 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: 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.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.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_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.