OSID Logo
OSID Specifications
transaction package
Version 3.0.0
Release Candidate Preview
Interfaceosid.transaction.batch.DeleteResponse
Implementsosid.OsidCapsule
Description

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.

MethodgetDeletedId
Description

Gets the reference Id of the object on which this item within the delete operation operated.

Returnosid.id.Idthe reference object Id
CompliancemandatoryThis method must be implemented.
MethodisSuccessful
Description

Tests if this item within the delete operation was successful.

Returnboolean true if the delete operation was successful, false if it was not successful
CompliancemandatoryThis method must be implemented.
MethodgetErrorMessage
Description

Gets the error message for an unsuccessful item within the delete operation.

Returnosid.locale.DisplayTextthe message
ErrorsILLEGAL_STATE isSuccessful() is true
CompliancemandatoryThis method must be implemented.