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 creates, updates, and deletes `Receipts`. A receipt exists for all messages where receipts are supported. The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Receipt`, a `ReceiptForm` is requested using `getReceiptFormForCreate()` specifying the desired `Message` and record `Types` or none if no record `Types` are needed. The returned `ReceiptForm` will indicate that it is to be used with a create operation and can be used to examine metadata or validate data prior to creation. Once the `ReceiptForm` is submitted to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ReceiptForm` corresponds to an attempted transaction. For updates, `ReceiptForms` are requested to the `Receipt` `Id` that is to be updated using `getReceiptFormForUpdate()`. 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. The delete operations delete `Receipts`. These delete operations attempt to remove the `Receipt` itself thus removing it from all known `Mailbox` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id. Like all `OsidSessions`, `ReceiptAdminSessions` are dedicated to single processing threads and a single authenticated user.
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	canCreateReceipts
Description	Tests if this user can create `Receipts`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Receipt` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Receipt` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateReceiptWithRecordTypes
Description	Tests if this user can create a single `Receipt` using the desired record types. While `MessagingManager.getReceiptRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Receipt`. Providing an empty array tests if a `Receipt` can be created with no records.
Parameters	`osid.type.Type[]`	`receiptRecordTypes`	array of receipt record types
Return	`boolean`		`true` if `Receipt` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`receiptRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptFormForCreate
Description	Gets the receipt form for creating new receipts. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`messageId`	the `Id` of the `Message`
Parameters	`osid.type.Type[]`	`receiptRecordTypes`	array of receipt record types
Return	`osid.messaging.ReceiptForm`		the receipt form
Errors	NOT_FOUND		`messageId` is not found
	NULL_ARGUMENT		`messageId` or `receiptRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createReceipt
Description	Creates a new `Receipt`.
Parameters	`osid.messaging.ReceiptForm`	`receiptForm`	the form for this `Receipt`
Return	`osid.messaging.Receipt`		the new `Receipt`
Errors	ILLEGAL_STATE		`receiptForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`receiptForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`receiptForm` did not originate from `getReceiptFormForCreate()`
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 `Receipt`
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.
Method	canDeleteReceipts
Description	Tests if this user can delete `Receipts`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Receipt` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Receipt` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteReceipt
Description	Deletes a `Receipt`.
Parameters	`osid.id.Id`	`receiptId`	the `Id` of the `Receipt` to remove
Errors	NOT_FOUND		`receiptId` 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	canManageReceiptAliases
Description	Tests if this user can manage `Id` aliases for `Receipts`. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Receipt` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasReceipt
Description	Adds an `Id` to a `Receipt` for the purpose of creating compatibility. The primary `Id` of the `Receipt` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another receipt, it is reassigned to the given receipt `Id`.
Parameters	`osid.id.Id`	`receiptId`	the `Id` of a `Receipt`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`receiptId` not found
	NULL_ARGUMENT		`aliasId` or `receiptId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.