OSID - osid.messaging.ReceiptAdminSession Service Interface Definition

Interface	osid.messaging.ReceiptAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.messaging.batch.ReceiptBatchAdminSession`
Used By	`osid.messaging.MessagingManager`
Used By	`osid.messaging.MessagingProxyManager`
Description	This session updates `Receipts`. A receipt exists for all messages where receipts are supported. The data for the update is provided by the consumer via the form object. `OsidForms` are requested for each update and may not be reused. `ReciptForms` are requested to the `Receipt` `Id` that is to be updated using `getReciptFormForUpdate()`. Similarly, the `ReceiptForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RecieptForm` can only be used once for a successful update and cannot be reused. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getMailboxId
Description	Gets the `Mailbox` `Id` associated with this session.
Return	`osid.id.Id`		the `Mailbox Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMailbox
Description	Gets the `Mailbox` associated with this session.
Return	`osid.messaging.Mailbox`		the `Mailbox` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateReceipts
Description	Tests if this user can update `Receipts`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Receipt` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Receipt` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptFormForUpdate
Description	Gets the receipt form for updating an existing receipt. A new receipt form should be requested for each update transaction.
Parameters	`osid.id.Id`	`receiptId`	the `Id` of the `Message`
Return	`osid.messaging.ReceiptForm`		the receipt form
Errors	NOT_FOUND		`receiptId` is not found
	NULL_ARGUMENT		`receiptId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateReceipt
Description	Updates an existing receipt.
Parameters	`osid.messaging.ReceiptForm`	`receiptForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`receiptForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`receiptForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`receiptForm` did not originate from `getReceiptFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.