public interface CreateResponse extends OsidCapsule
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.
Modifier and Type | Method and Description |
---|---|
Id |
getCreatedId()
Gets the
Id of the newly created object. |
DisplayText |
getErrorMessage()
Gets the error message for an unsuccessful item within the create
operation.
|
Id |
getFormId()
Gets the form
Id corresponding to this response. |
boolean |
isSuccessful()
Tests if this item within the create operation was successful.
|
Id getFormId()
Id
corresponding to this response. Id
mandatory
- This method must be implemented. boolean isSuccessful()
true
if the create operation was successful,
false
if it was not successfulmandatory
- This method must be implemented. Id getCreatedId()
Id
of the newly created object. Id
IllegalStateException
- isSuccessful()
is false
mandatory
- This method must be implemented. DisplayText getErrorMessage()
IllegalStateException
- isSuccessful()
is true
mandatory
- This method must be implemented.