public interface DispositionSchedule extends RMCustomObject
DispositionSchedule
object determines
how the Records Manager object is to be processed at the end of the specified retention period.Modifier and Type | Field and Description |
---|---|
static int |
CALENDER_DATE
An
int value that indicates that the triggering event for this
DispositionSchedule object is a calendar date. |
ACTION_AUTODELETE, ACTION_CUTTOFF, ACTION_DESTROY, ACTION_EXPORT, ACTION_INTRIMTRANSFER, ACTION_REVIEW, ACTION_TRANSFER, ACTION_VITAL_REVIEW, CYCLIC_EVENT, EXTERNAL_EVENT, IS_EQUAL, IS_GREATER, IS_GREATER_OR_EQUAL, IS_LESS, IS_LESS_OR_EQUAL, IS_NOT_EQUAL, IS_NOT_NULL, IS_NULL, LIKE, METADATA_EVENT, PREDEFINED_DATE_EVENT
AGGREGATION_RECORD, AGGREGATION_RECORD_CATEGORY, AGGREGATION_RECORD_FOLDER, AGGREGATION_VOLUME, CLEAR_INHERITED_CHILDREN, INHERIT_IMMEDIATE_CHILDREN, INHERITED_CHILDREN, NON_INHERITED_CHILDREN, WORK_FLOW_STATUS_COMPLETED, WORK_FLOW_STATUS_NOT_STARTED, WORK_FLOW_STATUS_STARTED
INVALID_CONTAINMENT_NAME_CHARACTERS
EXPORT_DEFAULT, EXPORT_ENCODED_CONTENT, EXPORT_FULL, EXPORT_OBJECT_ID, EXPORT_OBJECT_SECURITY, IMPORT_DEFAULT, IMPORT_OBJECT_ID, IMPORT_OWNER, IMPORT_PERMISSIONS, TYPE_ACTIVE_MARKING, TYPE_ANNOTATION, TYPE_ANY, TYPE_AUDIT_DEFINITION, TYPE_CBR_ENGINE_TYPE, TYPE_CHOICE, TYPE_CHOICELIST, TYPE_CLASS_SUBSCRIPTION, TYPE_CLASSDEFINITION, TYPE_CLASSDESCRIPTION, TYPE_COLUMN_DEFINITION, TYPE_COMPUTER, TYPE_CONTENT_CACHE_SERVICE, TYPE_CONTENT_MGR_SERVICE, TYPE_CONTENT_REFERENCE, TYPE_CONTENT_TRANSFER, TYPE_CUSTOMOBJECT, TYPE_DOCUMENT, TYPE_DOCUMENT_CLASSIFICATION_ACTION, TYPE_DOCUMENT_LIFECYCLE_ACTION, TYPE_DOCUMENT_LIFECYCLE_POLICY, TYPE_DOCUMENTSTATE, TYPE_DOMAIN, TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_ENTIRENETWORK, TYPE_EVENT, TYPE_EVENT_ACTION, TYPE_FEATURE_ADD_ON, TYPE_FILESTORE, TYPE_FOLDER, TYPE_GROUP, TYPE_INSTANCE_SUBSCRIPTION, TYPE_LINK, TYPE_LOCALIZED_STRING, TYPE_MARKING_SET, TYPE_MULTIPLEVALUES, TYPE_OBJECT_STORE, TYPE_OBJECTSET, TYPE_OBJSTORE_SERVICE, TYPE_PERMISSION, TYPE_PROPERTY_DEFINITION, TYPE_PROPERTYDESCRIPTION, TYPE_PROPERTYDESCRIPTIONS, TYPE_PUBLISH_REQUEST, TYPE_PUBLISH_TEMPLATE, TYPE_READONLY_OBJECT_SET, TYPE_REALM, TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_SECURITY_POLICY, TYPE_SECURITY_TEMPLATE, TYPE_STORAGE_POLICY, TYPE_STORED_SEARCH, TYPE_STYLE_TEMPLATE, TYPE_SUBSCRIBED_EVENT, TYPE_SUBSCRIPTION, TYPE_TABLE_DEFINITION, TYPE_TRANSIENT, TYPE_USER, TYPE_VERSIONSERIES, TYPE_WORKFLOW_CLASS_SUBSCRIPTION, TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION, TYPE_WORKFLOWDEFINITION, TYPE_XML_PROPERTY_MAPPING_SCRIPT
Modifier and Type | Method and Description |
---|---|
void |
addAlternateRetention(java.lang.String aoPhaseGuid,
com.filenet.wcm.api.Properties[] aoArrProps)
Creates
AlternateRetention objects for each element in a specified Properties
collection and associates the new objects with a specified Phase object. |
RMCustomObject |
createPhase(com.filenet.wcm.api.Properties aoProps,
com.filenet.wcm.api.Permissions aoACL)
Deprecated.
Use the
createPhaseWithAlternateRetention
method instead. |
RMCustomObject |
createPhaseWithAlternateRetention(com.filenet.wcm.api.Properties aoProps,
com.filenet.wcm.api.Permissions aoACLS,
com.filenet.wcm.api.Properties[] aoArrAltcreatePhaseWithAlternateRetentionernateRetentionProps)
Creates a
Phase object using the specified properties and permissions, and
adds the new object as the last entry in the Phase collection associated with
this DipositionSchedule object. |
void |
deleteAlternateRetention(java.lang.String asAlternateRetentionGuid)
Deletes a specified
AlternateRetention object. |
void |
deletePhase(java.lang.String asPhaseGuid)
Deletes the specified
Phase object and updates the sequence of all associated
Phase objects to reflect the change. |
RMCustomObjects |
getPhases()
Returns all
Phase objects that are associated with this DispositionSchedule
object. |
void |
modifyAlternateRetention(java.lang.String asAlternateRetentionGuid,
com.filenet.wcm.api.Properties aoProps)
Modifies the
Properties collection for a specified AlternateRetention object. |
void |
recalculateCutOff(DisposableObject aoRMObject)
Recalculates and updates the pre-cutoff data based on the schedule associated with a specified
DisposableObject object or its parent. |
void |
runDisposaltrigger(DispositionAllocatableObject aoDisAllObject)
Deprecated.
Use the
runDisposaltrigger(DispositionAllocatableObject, RecordInfos)
method instead. |
void |
runDisposaltrigger(DispositionAllocatableObject aoDisAllObject,
RecordInfos aoRecordInfos)
Checks the disposal event for the specified
DispositionAllocatableObject
object and, if the event has occurred, sets the pre-cutoff date and
other disposal-related data for the object or its children. |
void |
triggerNextPhase(RMObject aoRMObject)
Sets the subsequent phase data on the specified
RMObject object according to the schedule
object that is associated with the RMObject object or its parent. |
void |
updateCurrentPhaseDataOnEntity(DisposableObject aoDisposableObject)
Recalculates the phase data for the specified
DisposableObject object to
to cater conditions such as modification of to the phase or the object. |
void |
updateDateEffectiveModified()
Sets the
EffectiveDateModified property of this DipositionSchedule
object to the latest modified date on an associated trigger and cutoff action. |
void |
updatePhase(java.lang.String asPhaseGuid,
com.filenet.wcm.api.Properties aoProps,
com.filenet.wcm.api.Permissions aoACL)
Updates the specified
Phase object using the property and permission values that are
passed as parameters. |
void |
updatePhaseDataOnEntity(DisposableObject aoDisposableObject)
Recalculates the phase data for the specified
DisposableObject object to
reflect modifications to the phase or the object. |
void |
updatePhases(java.util.List aoPhasePropCollection,
com.filenet.wcm.api.Permissions aoPermissions)
Updates the associated phases with properties collection specified by the
aoPhasePropCollection
parameter, which provides a collection of collections in sequential order. |
getObjectStore, getRMDeclassificationOffset, getRMEntityType, getRMImplementationType, registerExternalEvent, setState
applySecurityTemplate, changeClass, delete, getHeadLinks, getHeadLinksXML, getPermissionsXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, raiseEvent
file, file, file, file, getContainers, getContainersXML, getContainmentNames, getContainmentPaths, getSecurityParent, setContainmentName, setContainmentName, setSecurityParent, unfile, unfile
getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML
setPermissions, setPermissions
setProperties, setProperties
getAccessMask, getPermissions, getPermissions
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
static final int CALENDER_DATE
int
value that indicates that the triggering event for this
DispositionSchedule
object is a calendar date.RMCustomObject createPhase(com.filenet.wcm.api.Properties aoProps, com.filenet.wcm.api.Permissions aoACL) throws RMException
createPhaseWithAlternateRetention
method instead.Phase
object in Content Engine and associates that
Phase
object with this DispositionSchedule
object.aoProps
- A Properties
collection that defines the properties
for the new Phase
object.aoACL
- A Permission
collection that defines the permissions
for the new Phase
object.RMCustomObject
object that represents the new Phase
object.RMException
- If a Records Manager error occurs.void updatePhase(java.lang.String asPhaseGuid, com.filenet.wcm.api.Properties aoProps, com.filenet.wcm.api.Permissions aoACL) throws RMException
Phase
object using the property and permission values that are
passed as parameters.asPhaseGuid
- A String
that represents the GUID of the Phase
object
to be modified.aoProps
- A Properties
collection that contains the property values to be applied
to the specified Phase
object.aoACL
- A Permissions
collection that contains the permission values to be applied
to the specified Phase
object.RMException
- If a Records Manager error occurs.void deletePhase(java.lang.String asPhaseGuid) throws RMException
Phase
object and updates the sequence of all associated
Phase
objects to reflect the change.asPhaseGuid
- A String
that represents the GUID of the Phase
object
to be deleted.RMException
- If a Records Manager error occurs.RMCustomObjects getPhases() throws RMException
Phase
objects that are associated with this DispositionSchedule
object.RMCustomObjects
collection containing the Phase
objects
that are associated with this DispositionSchedule
object.RMException
- If a Records Manager error occurs.void runDisposaltrigger(DispositionAllocatableObject aoDisAllObject, RecordInfos aoRecordInfos) throws RMException
DispositionAllocatableObject
object and, if the event has occurred, sets the pre-cutoff date and
other disposal-related data for the object or its children. The disposal event
that is associated with this DispositionSchedule
object determines
the objects to be modified by this method.aoDisAllObject
- The DispositionAllocatableObject
object for which
the disposal event is to be checked.aoRecordInfos
- If the DispositionAllocatableObject
object is
a RecordType
object, set this parameter to the RecordInfos
collection that contains the records associated with the RecordType
object.
For all other types of object, set this parameter to null.RMException
- If a Records Manager error occurs.void runDisposaltrigger(DispositionAllocatableObject aoDisAllObject) throws RMException
runDisposaltrigger(DispositionAllocatableObject, RecordInfos)
method instead.DispositionAllocatableObject
object and, if the event has occurred, sets the pre-cutoff date and
other disposal-related data for the object or its children. The disposal event
that is associated with this DispositionSchedule
object determines
the objects to be modified by this method.aoDisAllObject
- The DispositionAllocatableObject
object for which
the disposal event is to be checked.RMException
- If a Records Manager error occurs.void triggerNextPhase(RMObject aoRMObject) throws RMException
RMObject
object according to the schedule
object that is associated with the RMObject
object or its parent.aoRMObject
- The RMObject
object for which the disposal event is to be set.RMException
- If a Records Manager error occurs.void updateDateEffectiveModified() throws RMException
EffectiveDateModified
property of this DipositionSchedule
object to the latest modified date on an associated trigger and cutoff action.RMException
- If a Records Manager error occurs.void updatePhaseDataOnEntity(DisposableObject aoDisposableObject) throws RMException
DisposableObject
object to
reflect modifications to the phase or the object.aoDisposableObject
- The DisposableObject
object for which disposal data is to be set.RMException
- If a Records Manager error occurs.void updateCurrentPhaseDataOnEntity(DisposableObject aoDisposableObject) throws RMException
DisposableObject
object to
to cater conditions such as modification of to the phase or the object.aoDisposableObject
- The DisposableObject
object for which disposal data is to be set.RMException
- If a Records Manager error occurs.void updatePhases(java.util.List aoPhasePropCollection, com.filenet.wcm.api.Permissions aoPermissions) throws RMException
aoPhasePropCollection
parameter, which provides a collection of collections in sequential order.aoPhasePropCollection
- A List
object specifying the property collections for the
phase properties. Each phase property collection should contain the GUID of the phase to be updated.aoPermissions
- A Permissions
collection for all phases.RMException
- If a Records Manager error occurs.void addAlternateRetention(java.lang.String aoPhaseGuid, com.filenet.wcm.api.Properties[] aoArrProps)
AlternateRetention
objects for each element in a specified Properties
collection and associates the new objects with a specified Phase
object.aoPhaseGuid
- A String
representing the GUID of the Phase
object with
which the new AlternateRetention
objects are to be associated.aoArrProps
- The Properties
collection from which the AlternateRetention
objects are to be createdvoid modifyAlternateRetention(java.lang.String asAlternateRetentionGuid, com.filenet.wcm.api.Properties aoProps) throws RMException
Properties
collection for a specified AlternateRetention
object.asAlternateRetentionGuid
- A String
that represents the GUID of
the AlternateRetention
object that is to be modified.aoProps
- A Properties
collection containing the property values that
are to be applied to the specified AlternateRetention
object.RMException
- If a Records Manager error occurs.void deleteAlternateRetention(java.lang.String asAlternateRetentionGuid) throws RMException
AlternateRetention
object.asAlternateRetentionGuid
- A String
that represents the GUID of
the AlternateRetention
object to be deleted.RMException
- If a Records Manager error occurs.RMCustomObject createPhaseWithAlternateRetention(com.filenet.wcm.api.Properties aoProps, com.filenet.wcm.api.Permissions aoACLS, com.filenet.wcm.api.Properties[] aoArrAltcreatePhaseWithAlternateRetentionernateRetentionProps) throws RMException
Phase
object using the specified properties and permissions, and
adds the new object as the last entry in the Phase
collection associated with
this DipositionSchedule
object.aoProps
- The Properties
collection containing the property values for
the new Phase
object.aoACLS
- The Permissions
collection containing the permission values for
the new Phase
object.aoArrAltcreatePhaseWithAlternateRetentionernateRetentionProps
- RMCustomObject
object representing the new Phase
object.RMException
- If a Records Manager error occurs.void recalculateCutOff(DisposableObject aoRMObject)
DisposableObject
object or its parent. This method can be used
to verify the state of a DisposableObject
object before completion of
cut-off.aoRMObject
- The DisposableObject
for which pre-cutoff data is to be recalculated.© Copyright IBM Corp. 2003, 2013. All Rights Reserved.