com.filenet.rm.api

Interface DispositionSchedule

  • All Superinterfaces:
    com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.ContainableObject, com.filenet.wcm.api.CreatableObject, com.filenet.wcm.api.CustomObject, com.filenet.wcm.api.GettableObject, com.filenet.wcm.api.LockableObject, com.filenet.wcm.api.ReadableMetadataObject, com.filenet.wcm.api.ReadableSecurityObject, RMCustomObject, RMObject, java.io.Serializable, com.filenet.wcm.api.ValueObject, com.filenet.wcm.api.WorkflowTarget, com.filenet.wcm.api.WriteableMetadataObject, com.filenet.wcm.api.WriteableSecurityObject


    public interface DispositionSchedule
    extends RMCustomObject
    Represents a set instructions that are allocated to a Records Manager object to indicate how long that object is to be retained for business purposes. In addition, a DispositionSchedule object determines how the Records Manager object is to be processed at the end of the specified retention period.
    • Method Summary

      Methods 
      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)
      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.
      • Methods inherited from interface com.filenet.wcm.api.CustomObject

        applySecurityTemplate, changeClass, delete, getHeadLinks, getHeadLinksXML, getPermissionsXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, raiseEvent
      • Methods inherited from interface com.filenet.wcm.api.ContainableObject

        file, file, file, file, getContainers, getContainersXML, getContainmentNames, getContainmentPaths, getSecurityParent, setContainmentName, setContainmentName, setSecurityParent, unfile, unfile
      • Methods inherited from interface com.filenet.wcm.api.WorkflowTarget

        getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML
      • Methods inherited from interface com.filenet.wcm.api.WriteableSecurityObject

        setPermissions, setPermissions
      • Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject

        setProperties, setProperties
      • Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject

        getAccessMask, getPermissions, getPermissions
      • Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject

        getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
      • Methods inherited from interface com.filenet.wcm.api.BaseObject

        equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
      • Methods inherited from interface com.filenet.wcm.api.LockableObject

        extendLock, extendLock, isLocked, lock, unlock, unlock
    • Field Detail

      • CALENDER_DATE

        static final int CALENDER_DATE
        An int value that indicates that the triggering event for this DispositionSchedule object is a calendar date.
        See Also:
        Constant Field Values
    • Method Detail

      • createPhase

        RMCustomObject createPhase(com.filenet.wcm.api.Properties aoProps,
                                 com.filenet.wcm.api.Permissions aoACL)
                                   throws RMException
        Deprecated. Use the createPhaseWithAlternateRetention method instead.
        Creates a Phase object in Content Engine and associates that Phase object with this DispositionSchedule object.
        Parameters:
        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.
        Returns:
        An RMCustomObject object that represents the new Phase object.
        Throws:
        RMException - If a Records Manager error occurs.
      • updatePhase

        void updatePhase(java.lang.String asPhaseGuid,
                       com.filenet.wcm.api.Properties aoProps,
                       com.filenet.wcm.api.Permissions aoACL)
                         throws RMException
        Updates the specified Phase object using the property and permission values that are passed as parameters.
        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.
        Throws:
        RMException - If a Records Manager error occurs.
      • deletePhase

        void deletePhase(java.lang.String asPhaseGuid)
                         throws RMException
        Deletes the specified Phase object and updates the sequence of all associated Phase objects to reflect the change.
        Parameters:
        asPhaseGuid - A String that represents the GUID of the Phase object to be deleted.
        Throws:
        RMException - If a Records Manager error occurs.
      • getPhases

        RMCustomObjects getPhases()
                                  throws RMException
        Returns all Phase objects that are associated with this DispositionSchedule object.
        Returns:
        A RMCustomObjects collection containing the Phase objects that are associated with this DispositionSchedule object.
        Throws:
        RMException - If a Records Manager error occurs.
      • runDisposaltrigger

        void runDisposaltrigger(DispositionAllocatableObject aoDisAllObject,
                              RecordInfos aoRecordInfos)
                                throws RMException
        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. The disposal event that is associated with this DispositionSchedule object determines the objects to be modified by this method.
        Parameters:
        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.
        Throws:
        RMException - If a Records Manager error occurs.
      • runDisposaltrigger

        void runDisposaltrigger(DispositionAllocatableObject aoDisAllObject)
                                throws RMException
        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. The disposal event that is associated with this DispositionSchedule object determines the objects to be modified by this method.
        Parameters:
        aoDisAllObject - The DispositionAllocatableObject object for which the disposal event is to be checked.
        Throws:
        RMException - If a Records Manager error occurs.
      • triggerNextPhase

        void triggerNextPhase(RMObject aoRMObject)
                              throws RMException
        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.
        Parameters:
        aoRMObject - The RMObject object for which the disposal event is to be set.
        Throws:
        RMException - If a Records Manager error occurs.
      • updateDateEffectiveModified

        void updateDateEffectiveModified()
                                         throws RMException
        Sets the EffectiveDateModified property of this DipositionSchedule object to the latest modified date on an associated trigger and cutoff action.
        Throws:
        RMException - If a Records Manager error occurs.
      • updatePhaseDataOnEntity

        void updatePhaseDataOnEntity(DisposableObject aoDisposableObject)
                                     throws RMException
        Recalculates the phase data for the specified DisposableObject object to reflect modifications to the phase or the object.
        Parameters:
        aoDisposableObject - The DisposableObject object for which disposal data is to be set.
        Throws:
        RMException - If a Records Manager error occurs.
      • updateCurrentPhaseDataOnEntity

        void updateCurrentPhaseDataOnEntity(DisposableObject aoDisposableObject)
                                            throws RMException
        Recalculates the phase data for the specified DisposableObject object to to cater conditions such as modification of to the phase or the object.
        Parameters:
        aoDisposableObject - The DisposableObject object for which disposal data is to be set.
        Throws:
        RMException - If a Records Manager error occurs.
      • updatePhases

        void updatePhases(java.util.List aoPhasePropCollection,
                        com.filenet.wcm.api.Permissions aoPermissions)
                          throws RMException
        Updates the associated phases with properties collection specified by the aoPhasePropCollection parameter, which provides a collection of collections in sequential order.
        Parameters:
        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.
        Throws:
        RMException - If a Records Manager error occurs.
      • addAlternateRetention

        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.
        Parameters:
        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 created
      • modifyAlternateRetention

        void modifyAlternateRetention(java.lang.String asAlternateRetentionGuid,
                                    com.filenet.wcm.api.Properties aoProps)
                                      throws RMException
        Modifies the Properties collection for a specified AlternateRetention object.
        Parameters:
        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.
        Throws:
        RMException - If a Records Manager error occurs.
      • deleteAlternateRetention

        void deleteAlternateRetention(java.lang.String asAlternateRetentionGuid)
                                      throws RMException
        Deletes a specified AlternateRetention object.
        Parameters:
        asAlternateRetentionGuid - A String that represents the GUID of the AlternateRetention object to be deleted.
        Throws:
        RMException - If a Records Manager error occurs.
      • createPhaseWithAlternateRetention

        RMCustomObject createPhaseWithAlternateRetention(com.filenet.wcm.api.Properties aoProps,
                                                       com.filenet.wcm.api.Permissions aoACLS,
                                                       com.filenet.wcm.api.Properties[] aoArrAltcreatePhaseWithAlternateRetentionernateRetentionProps)
                                                         throws RMException
        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.
        Parameters:
        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 -
        Returns:
        An RMCustomObject object representing the new Phase object.
        Throws:
        RMException - If a Records Manager error occurs.
      • recalculateCutOff

        void recalculateCutOff(DisposableObject aoRMObject)
        Recalculates and updates the pre-cutoff data based on the schedule associated with a specified DisposableObject object or its parent. This method can be used to verify the state of a DisposableObject object before completion of cut-off.
        Parameters:
        aoRMObject - The DisposableObject for which pre-cutoff data is to be recalculated.

© Copyright IBM Corp. 2003, 2013. All Rights Reserved.