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

CreateResponses are returned from bulk create 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 create operations accept a list of OsidForms and to be created. There is one CreateResponse returned for every OsidForm supplied but not necessarily in the same order. The created Id in the response is the newly created Id is the create item was successful.

MethodgetFormId
Description

Gets the form Id corresponding to this response.

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

Tests if this item within the create operation was successful.

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

Gets the Id of the newly created object.

Returnosid.id.Idthe reference object Id
ErrorsILLEGAL_STATE isSuccessful() is false
CompliancemandatoryThis method must be implemented.
MethodgetErrorMessage
Description

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

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