com.ibm.jarm.api.core

Interface BulkItemResult



  • public interface BulkItemResult
    Represents the success or failure status for an individual entity that is a member of a BulkOperation process.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getEntityIdent()
      Returns the unique identifier for the entity that this BulkItemResult instance represents.
      RMRuntimeException getException()
      Returns any available RMRuntimeException associated with a failed operation.
      java.lang.Object getResultData()
      Returns associated result data, if any, for a successful BulkItemResult.
      boolean wasSuccessful()
      Indicates whether or not the operation was successful for the associated entity.
    • Method Detail

      • getEntityIdent

        java.lang.String getEntityIdent()
        Returns the unique identifier for the entity that this BulkItemResult instance represents.
        Returns:
        A String value.
      • wasSuccessful

        boolean wasSuccessful()
        Indicates whether or not the operation was successful for the associated entity.
        Returns:
        true if the operation was successful. false otherwise; the getException() method can supply any available failure information.
      • getResultData

        java.lang.Object getResultData()
        Returns associated result data, if any, for a successful BulkItemResult. For example, for a successful BulkItemResult returned from the BulkOperation.copyRecords operation, the getResultData() method returns a Record instance representing the result of the record copy operation.
        Returns:
        An Object value. For most bulk operations this is always a null value, but can be a Record instance in the case of the BulkOperation.copyRecords method.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.