Interface | osid.transaction.Transaction | ||
---|---|---|---|
Description |
A trsnaction is started upon creation of an | ||
Method | prepare | ||
Description |
Prepares for a | ||
Errors | ILLEGAL_STATE | this transaction has been committed or aborted | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
TRANSACTION_FAILURE | this transaction cannot proceed due to a bad transaction element | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
The provider must verify this transaction such that a
| ||
Method | commit | ||
Description |
Commits the transaction and makes the state change(s)
visible. This transaction is effectively closed and the
only valid method that may be invoked is | ||
Errors | ILLEGAL_STATE | this transaction has been committed or aborted | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
Any resources allocated for this transaction can be released. | ||
Method | abort | ||
Description |
Cancels this transaction, rolling back the queue of
operations since the start of this transaction. This
transaction is effectively closed and the only valid
method that may be invoked is | ||
Errors | ILLEGAL_STATE | this transaction has been committed or aborted | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
Any resources allocated for this transaction can be released. | ||
Method | getState | ||
Description |
Gets the current state of this transaction. | ||
Return | osid.transaction.TransactionState | the current state of this transaction | |
Compliance | mandatory | This method must be implemented. |