com.filenet.rm.api

Interface Volume

  • All Superinterfaces:
    ActivableObject, com.filenet.wcm.api.BaseObject, ClosableObject, DisposableObject, com.filenet.wcm.api.Folder, com.filenet.wcm.api.GettableObject, HoldableObject, com.filenet.wcm.api.LockableObject, com.filenet.wcm.api.ReadableMetadataObject, com.filenet.wcm.api.ReadableSecurityObject, RMFolder, RMObject, RMRecordContainer, java.io.Serializable, com.filenet.wcm.api.ValueObject, VitalableObject, com.filenet.wcm.api.WorkflowTarget, com.filenet.wcm.api.WriteableMetadataObject, com.filenet.wcm.api.WriteableSecurityObject


    public interface Volume
    extends RMRecordContainer, ClosableObject, HoldableObject, DisposableObject, ActivableObject, VitalableObject
    Represents a logical sub-division of a record folder into smaller, easier-to-manage units.

    You can instantiate a Volume object as follows:

    • Call the addVolume() method on a RecordFolder object to create a new volume in the file plan.
    • Call the getDeletedObjects() method on a ClassificationScheme to return the RMObject objects that are logically deleted.
    • Call the getVolumeInterface() method on an RMObjectStore object.
    • Call the getContainees() method on a RecordFolder object.

    • Method Detail

      • createVolume

        void createVolume(RecordFolder aoParent,
                        java.lang.String volumeName,
                        java.lang.String folderUniqueIdentifier,
                        java.lang.String asVolClassID,
                        com.filenet.wcm.api.Properties aoProps,
                        com.filenet.wcm.api.Permissions aoACLs)
                          throws RMException
        Creates a Volume object with specified properties and permissions in a RecordFolder object. The name of the newly created volume is specified in the asVolumeName parameter. Properties that are not specified and have default values in the Content Engine object store take the defaults. The Permissions collection contains elements for permissions to be assigned; null implies default permissions will be inherited.
        Parameters:
        aoParent - A RecordFolder object in which a Volume object is to be created. A RecordFolder object is the logical parent of a Volume object.
        volumeName - A String array identifying the customized name that you can change for volumes.
        folderUniqueIdentifier - A String representing the default generated pattern-filled volume name that is stored internally. This property is used to generate additional volume names.
        asVolClassID - A String containing the class for the Volume object.
        aoProps - A Properties collection containing the property values to be used in creating the new volume object.
        aoACLs - A Permissions collection that specifies the access permissions for the Volume. If null, the Volume object inherits from the default instance permissions of the class.
        Throws:
        RMException - If asClassificationSchemeName is null or empty, an RMException is thrown.
        RMException - If aoClassificationSchemeProps is null, an RMException is thrown.
        RMException - If any error occurs, an RMException is thrown.
      • editVolumeProperties

        void editVolumeProperties(com.filenet.wcm.api.Properties aoProperties,
                                java.lang.String volumeName,
                                java.lang.String folderUniqueIdentifier,
                                RecordFolder aoParent)
                                  throws RMException
        Edits the properties of the new instance of a volume that is to be created. Adds some system properties, such as location and home location to the properties collection passed to create a volume.
        Parameters:
        aoProperties - A Properties collection that contains the properties to be used to create a new instance of a volume.
        volumeName - A String array identifying the customized name that you can change for volumes.
        folderUniqueIdentifier - A String that is the name of a new instance of a volume that is to be created.
        aoParent - A RecordFolder object that is the parent RecordFolder of this new instance of a volume.
        Throws:
        RMException - If any error occurs, an RMException is thrown.
      • getParentRecordFolder

        RecordFolder getParentRecordFolder()
                                           throws RMException
        Returns a reference to the parent RecordFolder object for this object.
        Returns:
        The parent RecordFolder object for this object.
        Throws:
        RMException - If an error occurs, an RMException is thrown.

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