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

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.

MethodgetFormId
Description

Gets the form Id corresponding to this response.

Returnosid.id.Idthe form Id
CompliancemandatoryThis method must be implemented.
MethodgetUpdatedId
Description

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

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

Tests if this item within the update operation was successful.

Returnboolean true if the update 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 update operation.

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