Interface UpdateResponse

All Superinterfaces:
OsidCapsule
public interface UpdateResponse extends OsidCapsule

UpdateResponses are returned from bulk update operations. Batch-oriented methods are executed on a best effort basis unless wrapped in Transaction that supports an atomic commit() . Batch methods may be invoked outside of a Transaction where some of the items supplied may fail.

Bulk update operations accept a list of Ids to be updated with their corresponding OsidForms . There is one UpdateResponse returned for every OsidForm supplied but not necessarily in the same order. The updated Id in the response may be the primary Id of a given Id , and may differ.

  • Method Summary

    Modifier and Type
    Method
    Description
    DisplayText
    getErrorMessage()
    Gets the error message for an unsuccessful item within the update operation.
    Id
    getFormId()
    Gets the form Id corresponding to this response.
    Id
    getUpdatedId()
    Gets the reference Id of the object on which this item within the update operation operated.
    boolean
    isSuccessful()
    Tests if this item within the update operation was successful.

  • Method Details

    • getFormId

      Id getFormId()
      Gets the form Id corresponding to this response.
      Returns:
      the form Id
      Compliance:
      mandatory - This method must be implemented.

    • getUpdatedId

      Id getUpdatedId()
      Gets the reference Id of the object on which this item within the update operation operated.
      Returns:
      the reference object Id
      Compliance:
      mandatory - This method must be implemented.

    • isSuccessful

      boolean isSuccessful()
      Tests if this item within the update operation was successful.
      Returns:
      true if the update operation was successful, false if it was not successful
      Compliance:
      mandatory - This method must be implemented.

    • getErrorMessage

      DisplayText getErrorMessage()
      Gets the error message for an unsuccessful item within the update operation.
      Returns:
      the message
      Throws:
      IllegalStateException - isSuccessful() is true
      Compliance:
      mandatory - This method must be implemented.