com.ibm.jarm.api.core

Interface RecordFolderContainer

    • Method Detail

      • fetchRecordFolders

        PageableSet<RecordFolder> fetchRecordFolders(RMPropertyFilter filter,
                                                   java.lang.Integer pageSize)
        Returns a pageable collection of all RecordFolder instances that are immediate children of this container.
        Parameters:
        filter - An optional RMPropertyFilter defining retrieved properties for each returned RecordFolder 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 RecordFolder instances.
        Throws:
        RAL_RETRIEVING_RECORD_FOLDERS_FAILED - For any unexpected error condition.
      • addRecordFolder

        RecordFolder addRecordFolder(java.lang.String classIdent,
                                   RMProperties props,
                                   java.util.List<RMPermission> perms)
        Creates a new RecordFolder instance as an immediate child of this container and saves it to the associated FilePlanRepository.
        Parameters:
        classIdent - String identifier of the repository class to base the new instance on.
        props - the RMProperties collection to assign to the new instance.
        perms - an optional RMPermission collection to assign to the new instance.
        Returns:
        A new RecordFolder 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 RecordFolder.
        API_CANNOT_ADD_TO_INACTIVE_PARENT_CONTAINER - If this container is currently inactive.
        API_MISSING_REQUIRED_PROP_VALUE - If a required property has not been provided.
        API_NON_UNIQUE_CONTAINER_PROP_VALUE - If either the supplied "Record Folder Name" or "Folder Unique Identifier" property value is not unique within the parent container.
        RAL_ADD_RECORDFOLDER_FAILED - For any unexpected error condition.
      • addRecordFolder

        RecordFolder addRecordFolder(java.lang.String classIdent,
                                   RMProperties props,
                                   java.util.List<RMPermission> perms,
                                   java.lang.String idStr)
        Creates a new RecordFolder instance as an immediate child of this container and saves it to the associated FilePlanRepository.
        Parameters:
        classIdent - String identifier of the repository class to base the new instance on.
        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 RecordFolder 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 RecordFolder.
        API_CANNOT_ADD_TO_INACTIVE_PARENT_CONTAINER - If this container is currently inactive.
        API_MISSING_REQUIRED_PROP_VALUE - If a required property has not been provided.
        API_NON_UNIQUE_CONTAINER_PROP_VALUE - If either the supplied "Record Folder Name" or "Folder Unique Identifier" property value is not unique within the parent container.
        RAL_ADD_RECORDFOLDER_FAILED - For any unexpected error condition.

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