public interface ReceiptBatchAdminSession extends ReceiptAdminSession
This session updates Receipts
in bulk. The data for
update is provided by the consumer via the form object. OsidForms
are requested for each update and may not be reused.
For updates, ReceiptForms
are requested to the
Receipt
Id
that is to be updated using
getReceiptFormsForUpdate()
where the reference Id
in the ReceiptForm
may be used to link the request.
Similarly, the ReceiptForm
has metadata about the data that
can be updated and it can perform validation before submitting the update.
The ReceiptForm
can only be used once for a successful
update and cannot be reused.
Once a batch of ReceiptForms
are submitted for update,
an UpdateResponse
is returned for each ReceiptForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateReceipts(),
errors specific to an individual ReceiptForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating
ReceiptForm
through the ReceiptForm
Id.
Modifier and Type | Method and Description |
---|---|
ReceiptBatchFormList |
getReceiptFormsForUpdate(IdList receiptIds)
Gets the receipt forms for updating an existing set of receipts.
|
UpdateResponseList |
updateReceipts(ReceiptBatchFormList receiptForms)
Updates existing receipts.
|
canUpdateReceipts, getMailbox, getMailboxId, getReceiptFormForUpdate, updateReceipt
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ReceiptBatchFormList getReceiptFormsForUpdate(IdList receiptIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
receiptIds
- the Ids
of the Receipts
NotFoundException
- a receiptId
is not
foundNullArgumentException
- receiptIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateReceipts(ReceiptBatchFormList receiptForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.receiptForms
- the form containing the elements to be updatedNullArgumentException
- receiptForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.