com.ibm.jarm.api.core

Class BulkOperation

  • java.lang.Object
    • com.ibm.jarm.api.core.BulkOperation


  • public class BulkOperation
    extends java.lang.Object
    A class of static bulk operation methods that can apply to one or more entities in a single method call. This class is primarily intended to support multi-select user interface features.

    Each method returns a collection of BulkItemResult instances, each instance reports on the success or failure of a corresponding member entity.

    • Method Detail

      • activateContainers

        public static java.util.List<BulkItemResult> activateContainers(FilePlanRepository repository,
                                                        java.util.List<java.lang.String> entityIdents)
        Performs an activate operation on each of the specified RecordCategory and/or RecordFolder entities.

        Any error that occurs for any single entity is reported by that entity's associated BulkItemResult return value.

        Parameters:
        repository - The FilePlanRepository common to all entities.
        entityIdents - A collection of identity strings for the entities to be processed.
        Returns:
        A collection of BulkItemResult instances - one for each entity involved.
      • inactivateContainers

        public static java.util.List<BulkItemResult> inactivateContainers(FilePlanRepository repository,
                                                          java.util.List<java.lang.String> entityIdents,
                                                          java.lang.String commonReasonForInactivate)
        Performs an inactivate operation on each of the specified RecordCategory and/or RecordFolder entities.

        Any error that occurs for any single entity is reported by that entity's associated BulkItemResult return value.

        Parameters:
        repository - The FilePlanRepository common to all entities.
        entityIdents - A collection of identity strings for the entities to be processed.
        commonReasonForInactivate - A common "reason for inactivate" string to be used for each entity.
        Returns:
        A collection of BulkItemResult instances - one for each entity involved.
        Throws:
        API_REASON_FOR_INACTIVE_IS_REQUIRED - for a null or blank commonReasonForInactive input parameter.
      • closeContainers

        public static java.util.List<BulkItemResult> closeContainers(FilePlanRepository repository,
                                                     java.util.List<java.lang.String> entityIdents,
                                                     java.lang.String commonReasonForClose)
        Performs a close operation on each of the specified RecordCategory, RecordFolder and/or RecordVolume entities.

        Any error that occurs for any single entity is reported by that entity's associated BulkItemResult return value.

        Parameters:
        repository - The FilePlanRepository common to all entities.
        entityIdents - A collection of identity strings for the entities to be processed.
        commonReasonForClose - A common "reason for close" string to be used for each entity.
        Returns:
        A collection of BulkItemResult instances - one for each entity involved.
        Throws:
        API_REASON_FOR_CLOSE_IS_REQUIRED - for a null or blank commonReasonForClose input parameter.
      • reopenContainers

        public static java.util.List<BulkItemResult> reopenContainers(FilePlanRepository repository,
                                                      java.util.List<java.lang.String> entityIdents)
        Performs reopen on each of the specified RecordCategory, RecordFolder and/or RecordVolume entities.

        Any error that occurs for any single entity is reported by that entity's associated BulkItemResult return value.

        Parameters:
        repository - The FilePlanRepository common to all entities.
        entityIdents - A collection of identity strings for the entities to be processed.
        Returns:
        A collection of BulkItemResult instances - one for each entity involved.
      • placeHolds

        public static java.util.List<BulkItemResult> placeHolds(FilePlanRepository repository,
                                                java.util.List<BulkOperation.EntityDescription> entityDescriptions,
                                                java.util.List<java.lang.String> holdIdents)
        Each specified Hold is placed on each specified RecordCategory, RecordFolder, RecordVolume and/or Record entity.

        Any error that occurs for any single entity is reported by that entity's associated BulkItemResult return value. This includes any attempt to duplicate an existing hold on a particular entity.

        Parameters:
        repository - The FilePlanRepository common to all entities.
        entityDescriptions - A collection of BulkOperation.EntityDescription defining the entities to be processed.
        holdIdents - A collection of identity strings specifying the Hold instances to be applied.
        Returns:
        A collection of BulkItemResult instances - one for each entity involved.
        Throws:
        RAL_UNABLE_TO_RETRIEVE_HOLD - if any of the specified Hold instances is unavailable.
        API_CANNOT_APPLY_HOLD_THAT_IS_NOT_ACTIVE - if any of the specified Hold instances is currently not active.
      • removeHolds

        public static java.util.List<BulkItemResult> removeHolds(FilePlanRepository repository,
                                                 BulkOperation.EntityDescription entityDescription,
                                                 java.util.List<java.lang.String> holdIdents)
        Each specified Hold is removed from the specified RecordCategory, RecordFolder, RecordVolume or Record entity.

        Any error that occurs for any single hold is reported by that hold's associated BulkItemResult return value. This includes the situations where a specified hold is not placed on the entity or the specified hold is a "dynamic" hold.

        Parameters:
        repository - The FilePlanRepository common to all entities.
        entityDescription - An BulkOperation.EntityDescription defining the entity from which the holds are to be removed.
        holdIdents - A collection of identity strings for the Hold instances to be removed.
        Returns:
        A collection of BulkItemResult instances - one for each hold involved.
        Throws:
        RAL_BASEOBJECT_UNAVAILABLE - if the specified entity is unavailable.
        RAL_UNABLE_TO_RETRIEVE_HOLD - if any of specified holds are unavailable.
      • fileRecords

        public static java.util.List<BulkItemResult> fileRecords(FilePlanRepository repository,
                                                 java.util.List<java.lang.String> entityIdents,
                                                 java.lang.String destinationContainerIdent)
        Files each of the specified Record entities into the common specified destination RecordContainer.

        Any error that occurs for any single entity is reported by that entity's associated BulkItemResult return value.

        Parameters:
        repository - The FilePlanRepository common to all entities.
        entityIdents - A collection of identity strings for the Record entities to be processed.
        destinationContainerIdent - The identity string of the destination RecordContainer.
        Returns:
        A collection of BulkItemResult instances - one for each entity involved.
        Throws:
        API_CANNOT_FILE_INTO_INACTIVE_CONTAINER - if specified target container is inactive.
        API_CANNOT_FILE_INTO_CLOSED_CONTAINER - if specified target container is closed and current user does not have override right.
        RAL_NO_ACTIVE_VOLUME_AVAILABLE - if specified target container is a record folder an no child active volume is found.
      • moveRecords

        public static java.util.List<BulkItemResult> moveRecords(FilePlanRepository repository,
                                                 java.util.List<java.lang.String> entityIdents,
                                                 java.lang.String sourceContainerIdent,
                                                 java.lang.String destinationContainerIdent,
                                                 java.lang.String reasonForMove)
        Moves each of the specified Record entities from the specified source RecordContainer to the specified destination RecordContainer

        Any error that occurs for any single entity is reported by that entity's associated BulkItemResult return value.

        Parameters:
        repository - The FilePlanRepository common to all entities.
        entityIdents - A collection of identity strings for the Record entities to be processed.
        sourceContainerIdent - The identity string of the source RecordContainer.
        destinationContainerIdent - The identity string of the destination RecordContainer.
        reasonForMove - A string indicating why a record is being relocated.
        Returns:
        A collection of BulkItemResult instances - one for each entity involved.
        Throws:
        API_CANNOT_FILE_INTO_INACTIVE_CONTAINER - if specified target container is inactive.
        API_CANNOT_FILE_INTO_CLOSED_CONTAINER - if specified target container is closed and current user does not have override right.
        RAL_NO_ACTIVE_VOLUME_AVAILABLE - if specified target container is a record folder an no child active volume is found.
        API_CANNOT_FILE_RECORD_IT_ALREADY_EXISTS_IN_CONTAINER - if source and destination containers are the same.
      • copyRecords

        public static java.util.List<BulkItemResult> copyRecords(FilePlanRepository repository,
                                                 java.util.List<java.lang.String> entityIdents,
                                                 java.lang.String destinationContainerIdent,
                                                 java.lang.String namePrefix)
        Creates a copy of each of the specified Record entities in the common specified destination RecordContainer.

        Any error that occurs for any single entity is reported by that entity's associated BulkItemResult return value.

        Parameters:
        repository - The FilePlanRepository common to all entities.
        entityIdents - A collection of identity strings for the Record entities to be processed.
        destinationContainerIdent - The identity string of the destination RecordContainer.
        namePrefix - An optional string prefix to be applied to the original record's name to form the name for the new copy.
        Returns:
        A collection of BulkItemResult instances - one for each entity involved.
      • undeclareRecords

        public static java.util.List<BulkItemResult> undeclareRecords(FilePlanRepository repository,
                                                      java.util.List<java.lang.String> entityIdents)
        Undeclares each of the specified Record entities.

        Any error that occurs for any single entity is reported by that entity's associated BulkItemResult return value.

        Parameters:
        repository - The FilePlanRepository common to all entities.
        entityIdents - A collection of identity strings for the Record entities to be processed.
        Returns:
        A collection of BulkItemResult instances - one for each entity involved.
      • initiateDisposition

        public static java.util.List<BulkItemResult> initiateDisposition(FilePlanRepository repository,
                                                         java.util.List<BulkOperation.EntityDescription> entityDescriptions,
                                                         java.lang.Object vwSession)
        Performs necessary initiate disposition processing for each of the specified entities.

        Any error that occurs for any single entity is reported by that entity's associated BulkItemResult return value.

        Parameters:
        repository - The FilePlanRepository common to all entities.
        entityDescriptions - A collection of BulkOperation.EntityDescription defining the entities to be processed.
        vwSession - A filenet.vw.api.VWSession instance used for workflow-related operations.
        Returns:
        A collection of BulkItemResult instances - one for each entity that results in being included in any initiate disposition processing that takes place.

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