com.filenet.api.core
Class RetrievingBatch
- java.lang.Object
-
- com.filenet.api.core.Batch
-
- com.filenet.api.core.RetrievingBatch
-
public class RetrievingBatch extends Batch
Creates a batch operation to retrieve objects. Once created, the batch operation is pending until you call theretrieveBatch
method to perform the operation.- See Also:
BatchItemHandle
,UpdatingBatch
-
-
Method Summary
Methods Modifier and Type Method and Description BatchItemHandle
add(IndependentObject object, PropertyFilter filter)
Adds an object reference to the batch to be retrieved by this instance.static RetrievingBatch
createRetrievingBatchInstance(Domain domain)
Creates a newRetrievingBatch
instance for the specified FileNet P8 domain.boolean
hasExceptions()
Indicates whether any of the batch items have an associated exception as a result of the batch retrieval operation.void
retrieveBatch()
Retrieve all of the objects referenced in this batch.-
Methods inherited from class com.filenet.api.core.Batch
getBatchItemHandles
-
-
-
-
Method Detail
-
createRetrievingBatchInstance
public static RetrievingBatch createRetrievingBatchInstance(Domain domain)
Creates a newRetrievingBatch
instance for the specified FileNet P8 domain.- Parameters:
domain
- ADomain
object representing the FileNet P8 domain to use as the scope of thisRetrievingBatch
instance.- Returns:
- The
RetrievingBatch
object created.
-
add
public BatchItemHandle add(IndependentObject object, PropertyFilter filter)
Adds an object reference to the batch to be retrieved by this instance. The object is referenced by aBatchItemHandle
instance, and the batch contains a list ofBatchItemHandle
instances.- Parameters:
object
- AnIndependentObject
instance for the object to add.filter
- APropertyFilter
object that represents information for controlling which property values (and with what level of detail and recursion) to return. Ifnull
, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject
properties with a state ofPropertyState.UNEVALUATED
orPropertyState.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.
-
hasExceptions
public boolean hasExceptions()
Indicates whether any of the batch items have an associated exception as a result of the batch retrieval operation.- Returns:
- A
boolean
value of true if there is an exception associated with any batch item; false otherwise.
-
retrieveBatch
public void retrieveBatch()
Retrieve all of the objects referenced in this batch. Calling this method executes the pending batch retrieval operation.- Throws:
EngineRuntimeException
- Thrown when there are no pending items in the batch.
-
-