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.
Modifier and Type | Method and 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.
|
Id getFormId()
Id
corresponding to this response. Id
mandatory
- This method must be implemented. Id getUpdatedId()
Id
of the object on which this item
within the update operation operated. Id
mandatory
- This method must be implemented. boolean isSuccessful()
true
if the update operation was successful,
false
if it was not successfulmandatory
- This method must be implemented. DisplayText getErrorMessage()
IllegalStateException
- isSuccessful()
is true
mandatory
- This method must be implemented.