com.ibm.jarm.api.core

Interface RecordVolumeContainer

  • All Known Subinterfaces:
    RecordFolder


    public interface RecordVolumeContainer
    Represents a container capable of containing RecordVolume instances.
    • Method Detail

      • fetchRecordVolumes

        PageableSet<RecordVolume> fetchRecordVolumes(RMPropertyFilter filter,
                                                   java.lang.Integer pageSize)
        Returns a pageable collection of RecordVolume instances that are immediate children of this container.
        Parameters:
        filter - An optional RMPropertyFilter defining retrieved properties for each returned RecordVolume instance. This entry can be null.
        pageSize - An Integer defining the maximum number of results per returned page. This entry can be null, in which case a repository-specific default page size is used.
        Returns:
        a pageable collection of RecordVolume instances.
        Throws:
        RAL_RETRIEVING_RECORD_VOLUMES_FAILED - For any unexpected error condition.
      • addRecordVolume

        RecordVolume addRecordVolume(java.lang.String classIdent,
                                   java.lang.String volumeName,
                                   RMProperties props,
                                   java.util.List<RMPermission> perms)
        Creates a new RecordVolume instance as an immediate child of this container and saves it to the FilePlanRepository.

        If no volumeName parameter is provided, then one is automatically generated based upon the container's name with a suffix based upon the volume naming pattern defined for the file plan repository.

        Any previously active child RecordVolume is automatically closed and the newly created RecordVolume becomes the new active child RecordVolume.

        Parameters:
        classIdent - a String identifier of the repository class to base the new instance upon.
        volumeName - an optional String volume name to be used if provided.
        props - the RMProperties collection to assign to the new instance.
        perms - an optional RMPermission collection to assign to the new instance.
        Returns:
        A new RecordVolume instance.
        Throws:
        API_PARENT_CONTAINER_ISCLOSED - If this container is currently closed.
        API_CANNOT_CONTAIN_CHILDTYPE - If this container is not currently allowed to contain a RecordVolume.
        API_CANNOT_ADD_TO_INACTIVE_PARENT_CONTAINER - If this container is currently inactive.
        INVALID_VITAL_RECORD_PROPERTY - If proposed vital property state is incorrect.
        RAL_ADD_RECORDVOLUME_FAILED - For any unexpected error condition.
      • addRecordVolume

        RecordVolume addRecordVolume(java.lang.String classIdent,
                                   java.lang.String volumeName,
                                   RMProperties props,
                                   java.util.List<RMPermission> perms,
                                   java.lang.String idStr)
        Creates a new RecordVolume instance as an immediate child of this container and saves it to the FilePlanRepository.

        If no volumeName parameter is provided, then one is automatically generated based upon the container's name with a suffix based upon the volume naming pattern defined for the file plan repository.

        Any previously active child RecordVolume is automatically closed and the newly created RecordVolume becomes the new active child RecordVolume.

        Parameters:
        classIdent - a String identifier of the repository class to base the new instance upon.
        volumeName - an optional String volume name to be used if provided.
        props - the RMProperties collection to assign to the new instance.
        perms - an optional RMPermission collection to assign to the new instance.
        idStr - a String Id value to be assigned to the new instance. This parameter can be null in which case an Id value will be automatically generated for the new instance.
        Returns:
        A new RecordVolume instance.
        Throws:
        API_PARENT_CONTAINER_ISCLOSED - If this container is currently closed.
        API_CANNOT_CONTAIN_CHILDTYPE - If this container is not currently allowed to contain a RecordVolume.
        API_CANNOT_ADD_TO_INACTIVE_PARENT_CONTAINER - If this container is currently inactive.
        INVALID_VITAL_RECORD_PROPERTY - If proposed vital property state is incorrect.
        RAL_ADD_RECORDVOLUME_FAILED - For any unexpected error condition.
      • getActiveRecordVolume

        RecordVolume getActiveRecordVolume()
        Returns the current "active" child RecordVolume belonging to this container.
        Returns:
        A RecordVolume instance or null if no active RecordVolume is found.
        Throws:
        RAL_RETRIEVING_ACTIVE_VOLUME_FAILED - For any unexpected error condition.

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