com.filenet.rm.api

Interface RecordFolder

    • Method Detail

      • addVolume

        Volume addVolume(com.filenet.wcm.api.Properties volumeProps,
                       com.filenet.wcm.api.Permissions volumeACLs)
                         throws RMException
        Creates a Volume object within this RecordFolder object using the specified property and permission values.
        Parameters:
        volumeProps - A Properties collection containing the property values to be used in creating the new volume.
        volumeACLs - A Permissions collection containing the permission values to be used in creating the new volume.
        Throws:
        RMException - If a Records Manager error occurs.
      • addVolumeWithName

        Volume addVolumeWithName(com.filenet.wcm.api.Properties aVolumeProps,
                               com.filenet.wcm.api.Permissions aVolumeACLs)
                                 throws RMException
        Adds the Volume object within this instance of a RecordFolder object. Specify the properties and permissions as input parameters. The volume name can be specified in the properties object, or it is generated by the RM API.
        Parameters:
        aVolumeProps - A Properties collection containing the property values to be used in creating the new volume.
        aVolumeACLs - A Permissions collection containing the permission values to be used in creating the new volume.
        Returns:
        A Volume object that has been created.
        Throws:
        RMException - If this instance of RecordFolder is a Physical Container, a Volume object cannot be added to the Physical Container.
        RMException - In case of any error, an RMException is thrown.
      • getActiveVolume

        Volume getActiveVolume()
                               throws RMException
        Returns the Volume object that is currently active in this RecordFolder object.
        Returns:
        A Volume object. If no active volume is found, this method returns null.
        Throws:
        RMException - If a Records Manager error occurs.
      • move

        void move(RMFolder aoDestinationFolder,
                java.lang.String asReasonForRelocation,
                DispositionSchedule aoDispositionSchedule)
                  throws RMException
        Moves this RecordFolder object to a specified record category or a record folder.
        Parameters:
        aoDestinationFolder - An RMFolder object representing the record category or folder to which this object is to be moved.
        asReasonForRelocation - A String specifying the reason this object is being moved.
        aoDispositionSchedule - The DispositionSchedule object that represents the disposition schedule to be associated with this object after it is moved.
        Throws:
        RMException - If a Records Manager error occurs.
      • getLastCreatedVolume

        Volume getLastCreatedVolume()
                                    throws RMException
        Returns the Volume object that was most recently created within this RecordFolder object.
        Returns:
        A Volume object representing the newest volume within this object.
        Throws:
        RMException - If a Records Manager error occurs.

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