com.filenet.rm.api

Interface DisposableObject

  • All Superinterfaces:
    com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.ReadableMetadataObject, RMObject, java.io.Serializable, com.filenet.wcm.api.ValueObject
    All Known Subinterfaces:
    RecordCategory, RecordFolder, RecordInfo, Volume


    public interface DisposableObject
    extends RMObject
    Represents a Records Manager object that can be disposed of using the automated disposal process. A disposable object can be a record, record category, record folder, or volume.
    • Field Summary

      • Fields inherited from interface com.filenet.wcm.api.BaseObject

        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
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void clearDispositionData()
      Clears the disposition data from this object.
      void clearVitalData()
      Clears the vital data from this object.
      void completePhaseExecution(java.util.Date aoProposedCutoffDate, boolean abTriggerNextPhase)
      Completes the currently executing phase for this object by updating the current phase execution date metadata and cutoff metadata.
      void completePhaseExecution(java.util.Date aoProposedCutoffDate, boolean abTriggerNextPhase, boolean abHasCutOfAction)
      Completes the currently executing phase for this object by updating the current phase execution date and cutoff properties.
      void destroy(boolean abSave)
      Deletes this object either logically or physically from the object store.
      void destroy(boolean abSave, boolean abUnfileRecordWithRType)
      Deletes this object either logically or physically from the object store.
      void destroyWithoutSchedule(boolean abSave)
      Deletes this object either logically or physically from the object store without disposition schedule.
      void executeInterimTransfer(RMCustomObject aoIntTransLoc)
      Performs an interim transfer action on this object.
      void executeInterimTransferWithTransferAPI(RMCustomObject aoIntTransLoc, java.util.Map transferSourceContext, java.lang.String mappingGUID, boolean bSkipDisp)
      This method performs interim transfer action on the current instance of DisposableObject.
      void executeInterimTransferWithTransferAPI(RMCustomObject aoIntTransLoc, java.lang.String mappingGUID, boolean bSkipDisp)
      This method performs interim transfer action on the current instance of DisposableObject.
      void export()
      Exports this object and its children to XML files that, by default, are structured according to the Content Engine export schema.
      void exportWithTransferAPI(java.util.Map transferSourceContext, java.lang.String mappingGUID, boolean bSkipDisp)
      This method exports the given object as an XML with RM Transfer API, with the given Transfer Source Context.
      void exportWithTransferAPI(java.lang.String mappingGUID, boolean bSkipDisp)
      This method exports the given object as an XML with the RM Transfer API.
      java.util.HashMap initiateDisposition(filenet.vw.api.VWSession aoVWSession)
      Verifies the state of this object and its available children to launch the associated phase workflow with corresponding entities
      RMBulkOperationResults initiateDisposition(filenet.vw.api.VWSession aoVWSession, boolean abFailOnException)
      Verifies the state of this object and its available children to launch the associated phase workflow with corresponding entities
      void recalculateCuttOff()
      Recalculates the pre-cutoff data based on the schedule associated with this object or its parent to update the entity with pre-cutoff data.
      void review(com.filenet.wcm.api.Properties asProperties)
      Reviews this object and updates the specified properties.
      void setIsExportedBeforeDestroy(boolean abIsExported)
      Sets a flag that indicates whether an export has been done on this object prior to calling destroy.
      void transfer(boolean abSave)
      Transfers the metadata and content for this object to the physical drive specified by export destination metadata for the object.
      void updatePhaseDataOnEntity()
      Recalculates the currently executing phase data based on the schedule for this object or its parent, and updates the metadata for this object.
      void updatePhaseDataOnEntity(boolean abWithoutValidation)
      Updates the current phase execution data for this object without validating the associated schedule.
      • 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
    • Method Detail

      • setIsExportedBeforeDestroy

        void setIsExportedBeforeDestroy(boolean abIsExported)
        Sets a flag that indicates whether an export has been done on this object prior to calling destroy. This flag can help you determine if the destroy method, which is called separately, is part of a larger two-step transfer operation.
        Parameters:
        abIsExported - A boolean value set to true if this disposable object has been exported.
      • updatePhaseDataOnEntity

        void updatePhaseDataOnEntity()
                                     throws RMException
        Recalculates the currently executing phase data based on the schedule for this object or its parent, and updates the metadata for this object. This method facilitates the recalculation of dates and other properties as required to validate the state of this object before it is transferred to the next phase.
        Throws:
        RMException - If a Records Manager error occurs.
      • updatePhaseDataOnEntity

        void updatePhaseDataOnEntity(boolean abWithoutValidation)
                                     throws RMException
        Updates the current phase execution data for this object without validating the associated schedule.
        Parameters:
        abWithoutValidation - A boolean value set to true to update the phase execution data for this object without validating the associated schedule.
        Throws:
        RMException - If a Records Manager error occurs.
      • completePhaseExecution

        void completePhaseExecution(java.util.Date aoProposedCutoffDate,
                                  boolean abTriggerNextPhase)
                                    throws RMException
        Completes the currently executing phase for this object by updating the current phase execution date metadata and cutoff metadata. If the aoProposedCutoffDate parameter specifies a date later than the current date, then the new date becomes the current phase execution date to increase the span for the current phase in execution. Otherwise, this method calculates the next phase date based on the subsequent phase to be executed and updates the object with next phase data.
        Parameters:
        aoProposedCutoffDate - A Date value that specifies the phase execution date.
        abTriggerNextPhase - A boolean value set to true if the method is to trigger the next phase.
        Throws:
        RMException - If the aoDate parameter is null or if a Records Manager error occurs.
      • completePhaseExecution

        void completePhaseExecution(java.util.Date aoProposedCutoffDate,
                                  boolean abTriggerNextPhase,
                                  boolean abHasCutOfAction)
                                    throws RMException
        Completes the currently executing phase for this object by updating the current phase execution date and cutoff properties. If the aoProposedCutoffDate parameter specifies a date later than the current date, then the new date becomes the current phase execution date to increase the span for the current phase in execution. Otherwise, this method calculates the next phase date based on the subsequent phase to be executed and updates the object with next phase data.
        Parameters:
        aoProposedCutoffDate - A Date value that specifies the phase execution date.
        abTriggerNextPhase - A boolean value set to true if the method is to trigger the next phase.
        abHasCutOfAction - A boolean value set to true if a cut of action is in the schedule.
        Throws:
        RMException - If the aoDate parameter is null or if a Records Manager error occurs.
      • executeInterimTransfer

        void executeInterimTransfer(RMCustomObject aoIntTransLoc)
        Performs an interim transfer action on this object. When an interim transfer is performed, the metadata and content associated with this object and its children are exported to a physical drive. Then, all available electronic content is deleted from the file plan. In addition, the Location and HomeLocation (for physical entities only) properties of this object and its children are updated with the location specified by the aoIntTransLoc parameter.
        Parameters:
        aoIntTransLoc - An RMCustomObject that identifies the location to which the content is to be transferred.
        Throws:
        RMException - If the asLocation parameter is null, if an error occurs in retrieving record properties, or if a Records Manager error occurs. This method uses RM API to do the export.
      • executeInterimTransferWithTransferAPI

        void executeInterimTransferWithTransferAPI(RMCustomObject aoIntTransLoc,
                                                 java.lang.String mappingGUID,
                                                 boolean bSkipDisp)
        This method performs interim transfer action on the current instance of DisposableObject. When an entity is interim transferred both metadata and the content associated with entity and all its hierarchal children are exported to physical drive and then all the available electronic content is deleted from the Fileplan. Additionally the Location and HomeLocation (only incase of physical entities) metadata of entity and child entities are updated with Location object passed as parameter. This method uses RM Transfer API to do the export.
        Parameters:
        aoIntTransLoc - A custom object that represents the location object where content is to be interim transferred .
        mappingGUID - A string that represents the GUID of the Transfer Mapping Object.
        bSkipDisp - A boolean to indicate whether to skip disposition schedule validation, audit and phase rollback at error. This flag is set to true when launching workflows from UI, instead of by disposition schedules.
        Throws:
        RMException - If asLocation is null, an RMException is thrown.
        RMException - If an error occurs during retrieval of Record properties, an RMException is thrown.
        RMException - If any error occurs, an RMException is thrown.
      • executeInterimTransferWithTransferAPI

        void executeInterimTransferWithTransferAPI(RMCustomObject aoIntTransLoc,
                                                 java.util.Map transferSourceContext,
                                                 java.lang.String mappingGUID,
                                                 boolean bSkipDisp)
        This method performs interim transfer action on the current instance of DisposableObject. When an entity is interim transferred both metadata and the content associated with entity and all its hierarchal children are exported to physical drive and then all the available electronic content is deleted from the Fileplan. Additionally the Location and HomeLocation (only incase of physical entities) metadata of entity and child entities are updated with Location object passed as parameter. This method uses RM Transfer API to do the export with the given Transfer Source Context.
        Parameters:
        aoIntTransLoc - A custom object that represents the location object where content is to be interim transferred .
        transferSourceContext - A transfer source context map. The map can be created by calling RMTransferSupport.getTransferSourceContext() API.
        mappingGUID - A string that represents the GUID of the Transfer Mapping Object.
        bSkipDisp - A boolean to indicate whether to skip disposition schedule validation, audit and phase rollback at error. This flag is set to true when launching workflows from UI, instead of by disposition schedules.
        Throws:
        RMException - If asLocation is null, an RMException is thrown.
        RMException - If an error occurs during retrieval of Record properties, an RMException is thrown.
        RMException - If any error occurs, an RMException is thrown.
      • destroy

        void destroy(boolean abSave)
                     throws RMException
        Deletes this object either logically or physically from the object store.

        The isMinimumMetadataRetain property on the file plan determines whether this object and its associated metadata are deleted permanently from the object store. If the isMinimumMetadataRetained property is set to 0, this object is logically deleted. That is, the object is no longer visible in the user interface but continues to persist in the object store. If the isMinimumMetadataRetained property is set to 1, this object is completely erased from the system with only a minimum set of metadata pertaining it retained.

        Parameters:
        abSave - This parameter is no longer used.
        Throws:
        RMException - If a Records Manager error occurs.
      • destroyWithoutSchedule

        void destroyWithoutSchedule(boolean abSave)
                                    throws RMException
        Deletes this object either logically or physically from the object store without disposition schedule.

        The isMinimumMetadataRetain property on the file plan determines whether this object and its associated metadata are deleted permanently from the object store. If the isMinimumMetadataRetained property is set to 0, this object is logically deleted. That is, the object is no longer visible in the user interface but continues to persist in the object store. If the isMinimumMetadataRetained property is set to 1, this object is completely erased from the system with only a minimum set of metadata pertaining it retained.

        Parameters:
        abSave - This parameter is no longer used.
        Throws:
        RMException - If a Records Manager error occurs.
      • destroy

        void destroy(boolean abSave,
                   boolean abUnfileRecordWithRType)
                     throws RMException
        Deletes this object either logically or physically from the object store.

        The isMinimumMetadataRetain property on the file plan determines whether this object and its associated metadata are deleted permanently from the object store. If the isMinimumMetadataRetained property is set to 0, this object is logically deleted. That is, the object is no longer visible in the user interface but continues to persist in the object store. If the isMinimumMetadataRetained property is set to 1, this object is completely erased from the system with only a minimum set of metadata pertaining it retained.

        Parameters:
        abSave - This parameter is no longer used.
        abUnfileRecordWithRType - A boolean value set to true if the RecordInfo, in the hierarchy of current instance of RMRecordContainer, associated with a RecordType and filed elsewhere , is unfiled from this RMRecordContainer. If the Record is filed only in this RMRecordContainer, a DispositionConflictException exception is thrown. If false, the behavior is same as the destroy method with single boolean parameter. That is,a DispositionConflictException exception is always be thrown, for any RecordInfo in the hierarchy of this RMRecordContainer and associated with a RecordType.
        Throws:
        RMException - If a Records Manager error occurs.
      • initiateDisposition

        RMBulkOperationResults initiateDisposition(filenet.vw.api.VWSession aoVWSession,
                                                 boolean abFailOnException)
                                                   throws RMException
        Verifies the state of this object and its available children to launch the associated phase workflow with corresponding entities
        Parameters:
        aoVWSession - A VWSession object that is used to establish a session and log onto a Process Engine in order to launch a workflow.
        abFailOnException - A boolean value that indicates whether this method is to stop executing if an error occurs. Set to true if the method is to stop executing if an error occurs. Set to falseon if the method is to continue executing if an error occurs.
        Returns:
        An RMBulkOperationResults object that contains the IDs and descriptions for which disposition initiation failed.
        Throws:
        RMException - If this object or one of its children is either on hold or not ready for disposition.
      • initiateDisposition

        java.util.HashMap initiateDisposition(filenet.vw.api.VWSession aoVWSession)
                                              throws RMException
        Verifies the state of this object and its available children to launch the associated phase workflow with corresponding entities
        Parameters:
        aoVWSession - A VWSession object that is used to establish a session and log onto a Process Engine in order to launch a workflow.
        Returns:
        A HashMap object that contains the IDs and descriptions for which disposition initiation failed.
        Throws:
        RMException - If this object or one of its children is either on hold or not ready for disposition.
      • export

        void export()
        Exports this object and its children to XML files that, by default, are structured according to the Content Engine export schema. The method saves the XML files to the location that is specified by the export destination metadata for this object.

        To export this object to XML files that are structured according to a custom XML schema, you must specify that schema as the export format metadata for this object.

        There are two types of exported files:

        • Exported the Hierarchy of the Object: This file contains the data related to this object and its children.
        • Exported the Record, associated document and contents: This file contains the exported information for each Record with its associated documents and the content under tag.

        Throws:
        RMException - If this object is not ready to be exported or if a Records Manager error occurs.
      • exportWithTransferAPI

        void exportWithTransferAPI(java.lang.String mappingGUID,
                                 boolean bSkipDisp)
        This method exports the given object as an XML with the RM Transfer API. The XML files are saved on the destination location, specified in the ‘ExportDestination’ metadata on the object.
        Parameters:
        mappingGUID - A string that represents the GUID of the Transfer Mapping Object.
        bSkipDisp - A boolean to indicate whether to skip disposition schedule validation, audit and phase rollback at error. This flag is set to true when launching workflows from UI, instead of by disposition schedules.
      • exportWithTransferAPI

        void exportWithTransferAPI(java.util.Map transferSourceContext,
                                 java.lang.String mappingGUID,
                                 boolean bSkipDisp)
        This method exports the given object as an XML with RM Transfer API, with the given Transfer Source Context. The XML files are saved on the destination location, specified in the ‘ExportDestination’ metadata on the object.
        Parameters:
        transferSourceContext - A transfer source context map as specified in RM Transfer API. The map can be created by calling RMTransferSupport.getTransferSourceContext() API.
        mappingGUID - A string that represents the GUID of the Transfer Mapping Object.
        bSkipDisp - A boolean to indicate whether to skip disposition schedule validation, audit and phase rollback at error. This flag is set to true when launching workflows from UI, instead of by disposition schedules.
      • transfer

        void transfer(boolean abSave)
        Transfers the metadata and content for this object to the physical drive specified by export destination metadata for the object. The method then either logically or physically deletes the object and its children from the file plan as indicated by the isMinimumMetadataRetain flag set on the file plan.
        Parameters:
        abSave - This parameter is no longer used.
      • review

        void review(com.filenet.wcm.api.Properties asProperties)
                    throws RMException
        Reviews this object and updates the specified properties.
        Parameters:
        asProperties - A Property collection that contains the properties to be updated.
        Throws:
        RMException - If a Records Manager error occurs.
      • recalculateCuttOff

        void recalculateCuttOff()
        Recalculates the pre-cutoff data based on the schedule associated with this object or its parent to update the entity with pre-cutoff data. This method is designed to recalculate the dates to verify the state of this object before completion of cut-off.
      • clearDispositionData

        void clearDispositionData()
                                  throws RMException
        Clears the disposition data from this object.
        Throws:
        RMException - If a Records Manager error occurs.
      • clearVitalData

        void clearVitalData()
                            throws RMException
        Clears the vital data from this object.
        Throws:
        RMException - If a Records Manager error occurs.

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