com.filenet.api.core

Class UpdatingBatch


  • public class UpdatingBatch
extends Batch
    Creates a batch operation to update persisted objects. Once created, the batch operation is pending until you call the updateBatch method to commit the operation. The entire batch operation is executed within a single transaction.
    See Also:
    BatchItemHandle, RetrievingBatch

    • Method Detail

      • createUpdatingBatchInstance

        public static UpdatingBatch createUpdatingBatchInstance(Domain domain,
                                        RefreshMode refresh)
        Creates a new UpdatingBatch instance for the specified FileNet P8 domain.
        Parameters:
        domain - A Domain object representing the FileNet P8 domain to use as the scope of this UpdatingBatch instance.
        refresh - A RefreshMode object indicating whether the UpdatingBatch object returned is to contain refreshed data from the server.
        Returns:
        The UpdatingBatch object created.

      • add

        public BatchItemHandle add(IndependentlyPersistableObject object,
                  PropertyFilter filter)
        Adds an item to the batch to be updated by this instance. The item is referenced by a BatchItemHandle instance, and the batch is a list of BatchItemHandle instances.
        Parameters:
        object - An IndependentlyPersistableObject instance for the persisted object to update.
        filter - A PropertyFilter object that represents information for controlling which property values (and with what level of detail and recursion) to return. If null, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject properties with a state of PropertyState.UNEVALUATED or PropertyState.REFERENCE); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.
        Returns:
        A BatchItemHandle instance representing the object added to the batch.

      • hasPendingExecute

        public boolean hasPendingExecute()
        Indicates whether there are any pending items to update in this batch.
        Returns:
        A boolean value of true if one or more items is pending in this batch; false otherwise.

      • updateBatch

        public void updateBatch()
        Update all of the items in this batch. Calling this method commits the pending batch update operation. The batch operation is executed within a single transaction.
        Throws:
        EngineRuntimeException - Thrown when there are no pending items in the batch.
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

© Copyright IBM Corporation 2006, 2013. All rights reserved.