org.osid.messaging.batch

Interface ReceiptBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, ReceiptAdminSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.messaging.ReceiptAdminSession

canUpdateReceipts, getMailbox, getMailboxId, getReceiptFormForUpdate, updateReceipt

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getReceiptFormsForUpdate

ReceiptBatchFormList getReceiptFormsForUpdate(IdList receiptIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

receiptIds - the Ids of the Receipts

Returns:

the receipt form

Throws:

NotFoundException - a receiptId is not found

NullArgumentException - receiptIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateReceipts

UpdateResponseList updateReceipts(ReceiptBatchFormList receiptForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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 .

Parameters:

receiptForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - receiptForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.