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.
Modifier and Type | Method and 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.
|
Id getDeletedId()
Id
of the object on which this item
within the delete operation operated. Id
mandatory
- This method must be implemented. boolean isSuccessful()
true
if the delete 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.