OSID Logo
OSID Specifications
messaging batch package
Version 3.1.0
Interfaceosid.messaging.batch.ReceiptBatchAdminSession
Implementsosid.messaging.ReceiptAdminSession
Used Byosid.messaging.batch.MessagingBatchManager
osid.messaging.batch.MessagingBatchProxyManager
Description

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.

MethodgetReceiptFormsForUpdate
Description

Gets the receipt forms for updating an existing set of receipts. A new receipt form should be requested for each update transaction.

Parametersosid.id.IdListreceiptIds the Ids of the Receipts
Returnosid.messaging.batch.ReceiptBatchFormList the receipt form
ErrorsNOT_FOUND a receiptId is not found
NULL_ARGUMENT receiptIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodupdateReceipts
Description

Updates existing receipts. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse.

Parametersosid.messaging.batch.ReceiptBatchFormListreceiptForms the form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseList the update responses
ErrorsNULL_ARGUMENT receiptForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.