|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.api.core.Batch
com.filenet.api.core.RetrievingBatch
public class RetrievingBatch
Creates a batch operation to retrieve objects. Once created, the batch operation is pending until you call the
retrieveBatch
method to perform the operation.
BatchItemHandle
,
UpdatingBatch
Method Summary | |
---|---|
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 new RetrievingBatch 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 |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static RetrievingBatch createRetrievingBatchInstance(Domain domain)
RetrievingBatch
instance for the specified FileNet P8 domain.
domain
- A Domain
object representing the FileNet P8 domain to use as the scope of this
RetrievingBatch
instance.
RetrievingBatch
object created.public BatchItemHandle add(IndependentObject object, PropertyFilter filter)
BatchItemHandle
instance, and the batch contains a list of BatchItemHandle
instances.
object
- An IndependentObject
instance for the object to add.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.
BatchItemHandle
instance representing the object added to the batch.public boolean hasExceptions()
boolean
value of true if there is an exception associated with any batch item; false
otherwise.public void retrieveBatch()
EngineRuntimeException
- Thrown when there are no pending items in the batch.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |