Interface ReceiptBatchAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface ReceiptAdminSession

canUpdateReceipts, getMailbox, getMailboxId, getReceiptFormForUpdate, updateReceipt

Modifier and Type	Method	Description
boolean	canUpdateReceipts()	Tests if this user can update Receipts .
Mailbox	getMailbox()	Gets the Mailbox associated with this session.
Id	getMailboxId()	Gets the Mailbox Id associated with this session.
ReceiptForm	getReceiptFormForUpdate(Id receiptId)	Gets the receipt form for updating an existing receipt.
void	updateReceipt(ReceiptForm receiptForm)	Updates an existing receipt.

Method Details

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.