com.filenet.api.core
Interface BatchItemHandle


public interface BatchItemHandle

References objects for batch operations. A batch contains a list of BatchItemHandle instances. Methods are provided to retrieve the object referenced by a batch item and identify an exception (if any) associated with the item.

See Also:
Batch, RetrievingBatch, UpdatingBatch

Method Summary
 EngineRuntimeException getException()
          Returns the exception assigned to the batch item.
 IndependentObject getObject()
          Returns the object referenced by this batch item.
 boolean hasException()
          Indicates whether the batch item has an associated exception.
 

Method Detail

getObject

IndependentObject getObject()
Returns the object referenced by this batch item.

Returns:
An IndependentObject instance for the object referenced.

hasException

boolean hasException()
Indicates whether the batch item has an associated exception. This is only meaningful after the batch operation has been performed.

Returns:
A boolean value of true if there is an exception associated with the batch item; false otherwise.

getException

EngineRuntimeException getException()
Returns the exception assigned to the batch item. This is only meaningful after the batch operation has been performed.

Returns:
An EngineRuntimeException object containing the exception assigned to this batch item.


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