Creates a batch operation to retrieve objects.

Once created, the batch operation is pending until you call the RetrieveBatch method to perform the operation.


The following tables list the members exposed by RetrievingBatch.

Public Methods

 NameDescription
Public methodAddAdds an object reference to the batch to be retrieved by this instance.

The object is referenced by a BatchItemHandle instance, and the batch contains a list of BatchItemHandle instances.

Public methodStaticCreateRetrievingBatchInstanceCreates a new RetrievingBatch instance for the specified FileNet P8 domain.
Public methodEqualsDetermines whether the specified Object is equal to the current Object. (inherited from Object)
Public methodGetBatchItemHandlesReturns a list of the BatchItemHandle instances in this batch that reference the specified object, or, if the object parameter is Null, the list of all BatchItemHandle instances in this batch. (inherited from Batch)
Public methodGetHashCodeServes as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (inherited from Object)
Public methodGetTypeGets the Type of the current instance. (inherited from Object)
Public methodHasExceptionsIndicates whether any of the batch items have an associated exception as a result of the batch retrieval operation.
Public methodRetrieveBatchRetrieve all of the objects referenced in this batch. Calling this method executes the pending batch retrieval operation.
Public methodToStringReturns a String that represents the current Object. (inherited from Object)
Top

Protected Methods

 NameDescription
Family methodaddHandleAdds the specified BatchItemHandle to the collection. (inherited from Batch)
Family methodFinalizeAllows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (inherited from Object)
Family methodGetBatchListReturns the collection of BatchItemHandle instances. (inherited from Batch)
Family methodGetDomainReturns the domain for the collection. (inherited from Batch)
Family methodMemberwiseCloneCreates a shallow copy of the current Object. (inherited from Object)
Top

See Also