Interface DeleteResponse

All Superinterfaces:
OsidCapsule
public interface DeleteResponse extends OsidCapsule

DeleteResponses are returned from bulk delete 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.

While bulk delete operations may accept a list of Ids to be deleted. In this case, there is one DeleteResponse returned for every Id supplied but not necessarily in the same order. The reference Id in the response may be the primary Id of a given Id , and may differ.

Some bulk delete operations may operate on a set of criteria where a list of Ids are not supplied. In this case, there is one DeleteResponse generated for every Id that matches the criteria.

  • Method Summary

    Modifier and Type
    Method
    Description
    Id
    getDeletedId()
    Gets the reference Id of the object on which this item within the delete operation operated.
    DisplayText
    getErrorMessage()
    Gets the error message for an unsuccessful item within the delete operation.
    boolean
    isSuccessful()
    Tests if this item within the delete operation was successful.

  • Method Details

    • getDeletedId

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

    • isSuccessful

      boolean isSuccessful()
      Tests if this item within the delete operation was successful.
      Returns:
      true if the delete 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 delete operation.
      Returns:
      the message
      Throws:
      IllegalStateException - isSuccessful() is true
      Compliance:
      mandatory - This method must be implemented.