com.filenet.rm.api

Interface RecordInfo

  • All Superinterfaces:
    com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.ContainableObject, com.filenet.wcm.api.CreatableObject, DisposableObject, com.filenet.wcm.api.Document, com.filenet.wcm.api.GettableObject, HoldableObject, com.filenet.wcm.api.LockableObject, com.filenet.wcm.api.ReadableMetadataObject, com.filenet.wcm.api.ReadableSecurityObject, RMObject, RMRecord, java.io.Serializable, com.filenet.wcm.api.ValueObject, com.filenet.wcm.api.VersionableObject, VitalableObject, com.filenet.wcm.api.WorkflowTarget, com.filenet.wcm.api.WriteableMetadataObject, com.filenet.wcm.api.WriteableSecurityObject


    public interface RecordInfo
    extends RMRecord, HoldableObject, VitalableObject, DisposableObject
    Represents a a logical entity that serves as an official record for any type of document pertaining to business operations, or of having material value. A RecordInfo object can represent an electronic or a physical document, an image, or an e-mail.

    You obtain a RecordInfo object as follows:

    • Field Summary

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

        LIFECYCLE_CLEAR_EXCEPTION, LIFECYCLE_DEMOTE, LIFECYCLE_NO_CHANGE, LIFECYCLE_PROMOTE, LIFECYCLE_RESET, LIFECYCLE_SET_EXCEPTION, UNKNOWN_CONTENT_LENGTH
      • Fields inherited from interface com.filenet.wcm.api.ContainableObject

        INVALID_CONTAINMENT_NAME_CHARACTERS
      • Fields inherited from interface com.filenet.wcm.api.VersionableObject

        APPLY_STATE_ID_IN_PROCESS, APPLY_STATE_ID_RELEASED, APPLY_STATE_ID_RESERVATION, APPLY_STATE_ID_SUPERSEDED, RESERVATION_TYPE_COLLABORATIVE, RESERVATION_TYPE_DEFAULT, RESERVATION_TYPE_EXCLUSIVE, VERSION_STATUS_IN_PROCESS, VERSION_STATUS_RELEASED, VERSION_STATUS_RESERVATION, VERSION_STATUS_SUPERSEDED
      • 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 allocateRecordType(RecordType aoRecordType)
      Sets the AssociatedRecordType property for this RecordInfo object to the specified RecordType object.
      void attachReceiptToParent(RecordInfo aoRecordInfo)
      Attaches this RecordInfo object to the specified parent record as a receipt.
      void copy(RMRecordContainer aoDestination, com.filenet.wcm.api.Properties aoRecordProps)
      Creates a copy of this RecordInfo object in the specified RMRecordContainer object within the same file plan.
      void declassify(com.filenet.wcm.api.Properties aoRecordProps)
      Sets the security classification to declassify this RecordInfo object according to the DoD 5015.2-STD Chapter 4 standards.
      void delete(boolean abSave, java.lang.String asReasonForDelete)
      Deletes this RecordInfo object.
      void deleteFromParent(boolean abSave, java.lang.String asReasonForDelete, RMRecordContainer aoParent)
      Called by the specified RMRecordContainer object to delete this RecordInfo object in response to the destroy operation being invoked on that RMRecordContainer object.
      void destroyFromParent(boolean abSave, RMRecordContainer aoParent)
      Called by the specified RMRecordContainer object to delete this RecordInfo object in response to the destroy operation being invoked in a workflow on that RMRecordContainer object.
      RecordInfo detachReceiptFromParent()
      Detaches this RecordInfo object from a parent record as a receipt for that parent.
      void downgrade(com.filenet.wcm.api.Properties aoRecordProps)
      Sets the security classification for this RecordInfo object to a less restrictive level according to the DoD 5015.2-STD Chapter 4 standards.
      void file(RMRecordContainer aoDestination)
      Files this RecordInfo object in the specified RMRecordContainer object within the same file plan.
      java.lang.String[] getAssociatedDocumentIds()
      Returns the IDs of all Document objects associated with this RecordInfo object.
      RecordType getAssociatedRecordType()
      Returns the RecordType object with which this RecordInfo object is assoicated.
      com.filenet.wcm.api.TransportInputStream getContent()
      Obtains an input stream for the content element of the first Document object associated with this RecordInfo object.
      com.filenet.wcm.api.TransportInputStream getContent(java.lang.String asDocumentId)
      Obtains an input stream for the content element of the specified Document object that is associated with this RecordInfo object.
      com.filenet.wcm.api.Properties getDocumentProperties(java.lang.String asDocId, java.lang.String[] asArrProps)
      Returns the properties of a specified document that is associated with this RecordInfo object
      RecordCategories getParentRecordCategories()
      Returns a collection containing the record categories in which this RecordInfo object is filed.
      RecordFolders getParentRecordFolders()
      Returns a collection containing the RecordFolder objects in which this RecordInfo object is filed.
      RecordInfo getReceiptParent()
      Returns the parent record to which this RecordInfo object is attached as a receipt.
      RecordInfos getReceipts()
      Returns a collection of RecordInfo objects that are attached to this object as receipts.
      java.lang.String getRepositoryType()
      Returns a String that indicates the type of repository in which the document corresponding to this RecordInfo object is stored.
      java.lang.String getRetentionPropertiesXML()
      Returns the retention properties for this RecordInfo object, such as the cutoff date and current phase action.
      java.lang.String getSecurityParentHierarchicalPropertiesXML(java.lang.String[] asArrProps, int aiRMType)
      Returns the properties for either a security parent or the container of a security parent of this RecordInfo object.
      int isMinimumMetadataRetained()
      Retrieves the RetainMetadata property for the ClassificationScheme object to which this RecordInfo object belongs.
      void move(RMRecordContainer aoSource, RMRecordContainer aoDestination, java.lang.String asReasonForMove)
      Moves this RecordInfo object from one RMRecordContainer object to another in the same file plan.
      void setLastRetrievalOfRecordOnContainer(RMObjectStore aoRMObjectStore)
      Sets the LastRetrievalofRecord property for the container or containers in which this RecordInfo object is filed.
      void setProperties(com.filenet.wcm.api.Properties aoProperties, boolean abFlag)
      Sets the properties of this RecordInfo object to the specified values.
      void superceed(RecordInfo aoSupersededRecord)
      Supersedes this RecordInfo object with the specified RecordInfo object.
      void synchronizeDocumentFromRecord(com.filenet.wcm.api.Properties aoProperties)
      Updates the specified properties of the document or documents to which this RecordInfo object points.
      void synchronizeRecordFromDocument(com.filenet.wcm.api.Properties aoProperties, java.lang.String asDocumentId)
      Updates the specified properties of this RecordInfo object with values from the specified document.
      void undeclare()
      Undeclare the record from any associated documents and delete this record.
      void updateProperties(com.filenet.wcm.api.Properties aoRecordProps)
      Updates the classification data for this RecordInfo object.
      void upgrade(com.filenet.wcm.api.Properties aoRecordProps)
      Sets the security classification for this RecordInfo object to a more restrictive level according to the DoD 5015.2-STD Chapter 4 standards.
      • Methods inherited from interface com.filenet.wcm.api.Document

        applySecurityTemplate, applySecurityTemplate, canDemoteLifeCycleState, changeClass, changeLifeCycleState, delete, delete, deleteContentElement, getContentElement, getContentElement, getContentElementObjectTypes, getContentElementSequenceNumbers, getContentReferenceElementSequenceNumber, getContentReferenceElementSequenceNumber, getContentReferenceLocation, getContentReferenceLocation, getContentReferenceMimeType, getContentReferenceMimeType, getFilename, getFilename, getHeadLinks, getHeadLinksXML, getLifeCycleStates, getPermissionsXML, getPublications, getPublicationsXML, getPublishTemplates, getPublishTemplatesXML, getSecurityPolicyXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, getVersionSeries, getVersionsXML, isDependent, isPublication, publish, raiseEvent, republish, setContent, setContentReference
      • 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.VersionableObject

        cancelCheckout, checkin, checkin, checkout, checkout, demoteVersion, freeze, getReservation, getVersions, getVersions, promoteVersion
      • 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
      • 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
    • Method Detail

      • move

        void move(RMRecordContainer aoSource,
                RMRecordContainer aoDestination,
                java.lang.String asReasonForMove)
        Moves this RecordInfo object from one RMRecordContainer object to another in the same file plan.
        Parameters:
        aoSource - The RMRecordContainer in which this object currently resides.
        aoDestination - The RMRecordContainer in which this object is to be moved.
        asReasonForMove - A String specifying the reason this object is being moved.
        Throws:
        RMException - In the following situations:
        • If any parameter is null
        • If the aoSource and aoDestination parameters point to the same location
        • If the asReasonForMove parameter is empty
        • If the ReasonForRelocation property is not found for this object
        • If any error occurs
      • copy

        void copy(RMRecordContainer aoDestination,
                com.filenet.wcm.api.Properties aoRecordProps)
        Creates a copy of this RecordInfo object in the specified RMRecordContainer object within the same file plan.
        Parameters:
        aoDestination - The RMRecordContainer object in which a copy of this object is to be placed. This parameter must specify a destination container that can hold this object.
        aoRecordProps - A Properties collection containing the property values to be used in creating the copy of this object. At a minimum, this collection must contain the name to be assigned to the copy.
        Throws:
        RMException - If either parameter is null or if a Record Manager error occurs.
      • file

        void file(RMRecordContainer aoDestination)
        Files this RecordInfo object in the specified RMRecordContainer object within the same file plan.
        Parameters:
        aoDestination - The RMRecordContainer object in which this object is to be filed. The destination container must be able to hold this object.
        Throws:
        RMException - If the aoDestination is null, if this RecordInfo object is already filed in the specified destination container, or if a Records Manager error occurs.
      • synchronizeDocumentFromRecord

        void synchronizeDocumentFromRecord(com.filenet.wcm.api.Properties aoProperties)
        Updates the specified properties of the document or documents to which this RecordInfo object points. The aoProperties parameter identifies the properties that are to be updated. The values that are used to update these properties are retrieved from this RecordInfo object.
        Parameters:
        aoProperties - A Properties collection identifying the properties to be updated by this method. If this parameter is null, the method updates all properties.
        Throws:
        RMException - If the method could not retrieve the RecordedDocuments property of this object or if a Records Manager error occurs.
      • synchronizeRecordFromDocument

        void synchronizeRecordFromDocument(com.filenet.wcm.api.Properties aoProperties,
                                         java.lang.String asDocumentId)
        Updates the specified properties of this RecordInfo object with values from the specified document. The aoProperties parameter identifies the properties that are to be updated. The values that are used to update these properties are retrieved from this RecordInfo object.
        Parameters:
        aoProperties - A Properties collection identifying the properties to be updated by this method. If this parameter is null, the method updates all properties.
        asDocumentId - A String specifying the ID of the document from which this method is to retrieve the new property values.
        Throws:
        RMException - If the method could not retrieve the RecordedDocuments property of this object or if a Records Manager error occurs.
      • getParentRecordFolders

        RecordFolders getParentRecordFolders()
                                             throws RMException
        Returns a collection containing the RecordFolder objects in which this RecordInfo object is filed.
        Returns:
        A RecordFolders collection containing the RecordFolder objects in which this object is filed.
        Throws:
        RMException - If the FolderType property could not be retrieved for any RMFolder object or if a Records Manager error occurs.
      • getParentRecordCategories

        RecordCategories getParentRecordCategories()
                                                   throws RMException
        Returns a collection containing the record categories in which this RecordInfo object is filed. Each record category in the collection is an immediate parent of the object.
        Returns:
        A RecordCategories collection containing the RecordCategory objects in which this object is filed.
        Throws:
        RMException - If the implementation type is not DoD, if the FolderType property could not be retrieved for any RMFolder object, or if a Records Manager error occurs.
      • isMinimumMetadataRetained

        int isMinimumMetadataRetained()
                                      throws RMException
        Retrieves the RetainMetadata property for the ClassificationScheme object to which this RecordInfo object belongs. The RetainMetadata property indicates whether minimum metadata is to be saved when this object is deleted.
        Returns:
        An int value indicating the RetainMetadata property value as follows:

        • 0 - The entity is logically deleted. That is, minimum metadata is retained on deletion and the IsDeleted property of the relevant RM entity is set to true.
        • 1 - The entity is completely deleted without saving any minimum metadata.
        • 2 - The user is to be prompted when deleting an entity to specify whether minimum metadata should be retained.

        Throws:
        RMException - If a Records Manager error occurs.
      • getRepositoryType

        java.lang.String getRepositoryType()
                                           throws RMException
        Returns a String that indicates the type of repository in which the document corresponding to this RecordInfo object is stored.
        Returns:
        A String indicating the type of repository in which the document corresponding to this object is stored. For example, this method returns CE if the document is stored in a Content Engine repository.
        Throws:
        RMException - If a Records Manager error occurs.
      • getAssociatedRecordType

        RecordType getAssociatedRecordType()
                                           throws RMException
        Returns the RecordType object with which this RecordInfo object is assoicated.
        Returns:
        The RecordType object associated with this object. Returns null if no RecordType object is associated with this object
        Throws:
        RMException - If a Records Manager error occurs.
      • delete

        void delete(boolean abSave,
                  java.lang.String asReasonForDelete)
                    throws RMException
        Deletes this RecordInfo object.
        Parameters:
        abSave - A boolean value that is used if the RetainMetadata property for this object is set to 2. Set this parameter to true if the minimum metadata is to be retained when this object is deleted. Set to false if all metadata is to be deleted when this object is deleted.
        asReasonForDelete - A String that specifies the reason this object is being deleted.
        Throws:
        RMException - If this object is on hold and cannot be deleted or if a Records Manager error occurs.
      • allocateRecordType

        void allocateRecordType(RecordType aoRecordType)
                                throws RMException
        Sets the AssociatedRecordType property for this RecordInfo object to the specified RecordType object.
        Parameters:
        aoRecordType - The RecordType object to be associated with this object.
        Throws:
        RMException - If the aoRecordType parameter is null or if a Records Manager error occurs.
      • destroyFromParent

        void destroyFromParent(boolean abSave,
                             RMRecordContainer aoParent)
                               throws RMException
        Called by the specified RMRecordContainer object to delete this RecordInfo object in response to the destroy operation being invoked in a workflow on that RMRecordContainer object.
        Parameters:
        abSave - A boolean value that is used if the RetainMetadata property for this object is set to 2. Set to true if the minimum metadata is to be retained when this object is deleted. Set to false if all metadata is to be deleted when this object is deleted.
        aoParent - The RMRecordContainer object from which this method is to be called.
        Throws:
        RMException - If a Records Manager error occurs.
      • deleteFromParent

        void deleteFromParent(boolean abSave,
                            java.lang.String asReasonForDelete,
                            RMRecordContainer aoParent)
                              throws RMException
        Called by the specified RMRecordContainer object to delete this RecordInfo object in response to the destroy operation being invoked on that RMRecordContainer object.
        Parameters:
        abSave - A boolean value that is used if the RetainMetadata property for this object is set to 2. Set to true if the minimum metadata is to be retained when this object is deleted. Set to false if all metadata is to be deleted when this object is deleted.
        asReasonForDelete - A String that specifies the reason for this object is being deleted.
        aoParent - The RMRecordContainer object from which this method is to be called.
        Throws:
        RMException - If a Records Manager error occurs.
      • getAssociatedDocumentIds

        java.lang.String[] getAssociatedDocumentIds()
                                                    throws RMException
        Returns the IDs of all Document objects associated with this RecordInfo object.
        Returns:
        A String array containing the IDs of all Document objects associated with this object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getContent

        com.filenet.wcm.api.TransportInputStream getContent()
                                                            throws RMException
        Obtains an input stream for the content element of the first Document object associated with this RecordInfo object.
        Specified by:
        getContent in interface com.filenet.wcm.api.Document
        Returns:
        A TransportInputStream object containing the document content.
        Throws:
        RMException - If a Records Manager error occurs.
      • getContent

        com.filenet.wcm.api.TransportInputStream getContent(java.lang.String asDocumentId)
                                                            throws RMException
        Obtains an input stream for the content element of the specified Document object that is associated with this RecordInfo object.
        Parameters:
        asDocumentId - A String representing the ID of the Document object for which content is to be returned.
        Returns:
        A TransportInputStream object containing the document content.
        Throws:
        RMException - If a Records Manager error occurs.
      • setProperties

        void setProperties(com.filenet.wcm.api.Properties aoProperties,
                         boolean abFlag)
        Sets the properties of this RecordInfo object to the specified values. If the abFlag parameter is set to true, this method sets the recalculatephaseretention property of this object to PHASE_RECALCULATION_REQUIRED.
        Specified by:
        setProperties in interface com.filenet.wcm.api.WriteableMetadataObject
        Parameters:
        aoProperties - A Properties collection containing the property values to be set for this object.
        abFlag - A boolean value that specifies whether the recalculatephaseretention prperty is to be reset.
      • superceed

        void superceed(RecordInfo aoSupersededRecord)
                       throws RMException
        Supersedes this RecordInfo object with the specified RecordInfo object. The SupercededBy property for this object is updated to point to the specified RecordInfo object.
        Parameters:
        aoSupersededRecord - The RecordInfo object that is to supersede this object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getDocumentProperties

        com.filenet.wcm.api.Properties getDocumentProperties(java.lang.String asDocId,
                                                           java.lang.String[] asArrProps)
                                                             throws RMException
        Returns the properties of a specified document that is associated with this RecordInfo object
        Parameters:
        asDocId - A String that specifies the ID of the document whose properties are to be returned.
        asArrProps - A String array identifying the specific properties to be returned. Set this parameter to null to return all properties.
        Returns:
        Returns a Properties collection containing the specified document properties.
        Throws:
        RMException - If a Records Manager error occurs.
      • getSecurityParentHierarchicalPropertiesXML

        java.lang.String getSecurityParentHierarchicalPropertiesXML(java.lang.String[] asArrProps,
                                                                  int aiRMType)
                                                                    throws RMException
        Returns the properties for either a security parent or the container of a security parent of this RecordInfo object.

        The aiRMType parameter determines whether this method returns properties for the security parent or a container of the security parent. If this parameter is set to 0, this method returns the properties for the security parent. If the parameter is set to an RMType value, the method searches from the security parent up the file plan hierarchy, and returns the properties of the first container object of the specified type that it finds. For example, if the security parent for this RecordInfoobject is an electronic record folder and you set the aiRMType parameter to RMType.RM_TYPE_RECORDCATEGORY, this method returns the properties of the RecordCategory object in which the folder is filed.

        Parameters:
        asArrProps - A String array specifying the properties that the method is to return.
        aiRMType - An int value set to 0 to return the properties for the security parent or to an RMType value to return the properties for the security parent container. The RMType value you specify must represent an object that is capable of containing the security parent. For example, an exception is thrown if the security parent is a record category and you specify the value of the aiRMType parameter as RMType.RM_TYPE_ELECTRONICRECORDFOLDER.
        Returns:
        A String containing the property values for either the security parent or the container of the security parent of this RecordInfo object.
        Throws:
        RMException - If the aiRMType parameter represents a type of object that cannot contain the security parent.
      • getRetentionPropertiesXML

        java.lang.String getRetentionPropertiesXML()
                                                   throws com.filenet.wcm.api.PropertyNotFoundException,
                                                          javax.xml.parsers.ParserConfigurationException
        Returns the retention properties for this RecordInfo object, such as the cutoff date and current phase action.

        The method determines where to obtain the retention properties as follows:

        • If a RecordType object is associated with this object, the method returns the retention properties from the DispositionSchedule object associated with the RecordType object.
        • If no RecordType object is associated with this object, the method returns the retention properties from the DispositionSchedule object associated with the folder specified by the CutoffInheritedFrom property for this object.
        • If no RecordType object is associated with this object and the CutoffInheritedFrom property is null, the method returns the retention properties from the security parent of this object.

        Returns:
        A String containing the retention properties in XML format.
        Throws:
        com.filenet.wcm.api.PropertyNotFoundException - If any property is not found.
        javax.xml.parsers.ParserConfigurationException - If the method is not able to parse the XML String.
      • setLastRetrievalOfRecordOnContainer

        void setLastRetrievalOfRecordOnContainer(RMObjectStore aoRMObjectStore)
                                                 throws RMException
        Sets the LastRetrievalofRecord property for the container or containers in which this RecordInfo object is filed. The method sets the property only if the LastRetrievalOfRecord.vbs COM event is subscribed on the RMSystem class for the Creation trigger.
        Parameters:
        aoRMObjectStore - An RMObjectStore object specifying the object store in which this object resides.
        Throws:
        RMException - If a Records Manager error occurs.
      • upgrade

        void upgrade(com.filenet.wcm.api.Properties aoRecordProps)
                     throws RMException
        Sets the security classification for this RecordInfo object to a more restrictive level according to the DoD 5015.2-STD Chapter 4 standards. Before reclassifying this object, the method verifies that that the requested update meets the DoD Chapter 4 requirements.
        Parameters:
        aoRecordProps - A Properties collection that contains the properties to be modified.
        Throws:
        RMException - If a Records Manager error occurs. If errors occur during validation of the business rules, the error message provides a comma-separated list of the errors.
      • downgrade

        void downgrade(com.filenet.wcm.api.Properties aoRecordProps)
                       throws RMException
        Sets the security classification for this RecordInfo object to a less restrictive level according to the DoD 5015.2-STD Chapter 4 standards. Before reclassifying this object, the method verifies that that the requested update meets the DoD Chapter 4 requirements.
        Parameters:
        aoRecordProps - A Properties collection that contains the properties to be modified.
        Throws:
        RMException - If a Records Manager error occurs. If errors occur during validation of the business rules, the error message provides a comma-separated list of the errors.
      • declassify

        void declassify(com.filenet.wcm.api.Properties aoRecordProps)
                        throws RMException
        Sets the security classification to declassify this RecordInfo object according to the DoD 5015.2-STD Chapter 4 standards. Before reclassifying this object, the method verifies that that the requested update meets the DoD Chapter 4 requirements.
        Parameters:
        aoRecordProps - A Properties collection that contains the properties to be modified.
        Throws:
        RMException - If a Records Manager error occurs. If errors occur during validation of the business rules, the error message provides a comma-separated list of the errors.
      • updateProperties

        void updateProperties(com.filenet.wcm.api.Properties aoRecordProps)
                              throws RMException
        Updates the classification data for this RecordInfo object. Before updating the data, the method verifies that the requested changes meets the DoD Chapter 4 requirements.
        Parameters:
        aoRecordProps - A Properties collection that contains the properties to be modified.
        Throws:
        RMException - If a Records Manager error occurs. If errors occur during validation of the business rules, the error message provides a comma-separated list of the errors.
      • attachReceiptToParent

        void attachReceiptToParent(RecordInfo aoRecordInfo)
                                   throws RMException
        Attaches this RecordInfo object to the specified parent record as a receipt.
        Parameters:
        aoRecordInfo - A RecordInfo object representing the parent record to which this object is to be attached as a receipt.
        Throws:
        RMException - If this object is already a receipt or receipt parent or if the specified parent is a receipt.
      • detachReceiptFromParent

        RecordInfo detachReceiptFromParent()
                                           throws RMException
        Detaches this RecordInfo object from a parent record as a receipt for that parent. This method does not delete either this object or the parent record.
        Returns:
        A RecordInfo object representing the parent record to which this object was attached as a receipt.
        Throws:
        RMException - If this RecordInfo object is not a receipt.
      • getReceiptParent

        RecordInfo getReceiptParent()
                                    throws RMException
        Returns the parent record to which this RecordInfo object is attached as a receipt.
        Returns:
        A RecordInfo object representing the parent record to which this object is attached as a receipt. Returns null if this object is not a receipt or if it has no parent record.
        Throws:
        RMException - If this RecordInfo object is not a receipt.
      • getReceipts

        RecordInfos getReceipts()
                                throws RMException
        Returns a collection of RecordInfo objects that are attached to this object as receipts.
        Returns:
        A RecordInfos collection containing the RecordInfo objects attached to this object as receipts. Returns an empty collection if no receipts are attached to this object.
        Throws:
        RMException - If a Records Manager error occurs.
      • undeclare

        void undeclare()
                       throws RMException
        Undeclare the record from any associated documents and delete this record.

        A successful undeclare operation involves disconnecting each associated document or document version from the record and deletion of the record. Each of their respective security settings reverts back to the security setting of the document before it was declared.

        Any one of the following situations prevents the undeclare operation from proceeding:

        • The record or its parent is currently on hold.
        • The record is currently involved in an active workflow (for example, a disposition workflow).
        • The record is marked as logically deleted.
        • The record's content is federated.
        • The record cannot be undeclared for any other reason (for example, lack of security).

        Throws:
        RMException - If any one of the above listed prevention situations exists or any other exception situation arises.

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