OSID - osid.messaging.ReceiptMailboxAssignmentSession Service Interface Definition

Interface	osid.messaging.ReceiptMailboxAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.messaging.MessagingManager`
Used By	`osid.messaging.MessagingProxyManager`
Description	This session provides methods to re-assign `Receipts` to `Mailboxes`. A `Receipt` may map to multiple `Mailbox` objects and removing the last reference to a `Receipt` is the equivalent of deleting it. Each `Mailbox` may have its own authorizations governing who is allowed to operate on it. Moving or adding a reference of a `Receipt` to another `Mailbox` is not a copy operation (eg: does not change its `Id`). Like all `OsidSessions`, `ReceiptMailboxAssignmentSessions` are dedicated to single processing threads and a single authenticated user.
Method	canAssignReceipts
Description	Tests if this user can alter receipt/mailbox mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignReceiptsToMailbox
Description	Tests if this user can alter receipt/mailbox mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the `Mailbox`
Return	`boolean`		`false` if messaging is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`mailboxId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableMailboxIds
Description	Gets a list of mailboxes including and under the given mailbox node in which any receipt can be assigned.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the `Mailbox`
Return	`osid.id.IdList`		list of assignable mailbox `Ids`
Errors	NULL_ARGUMENT		`mailboxId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableMailboxIdsForReceipt
Description	Gets a list of mailboxes including and under the given mailbox node in which a specific receipt can be assigned.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the `Mailbox`
Parameters	`osid.id.Id`	`messageId`	the `Id` of the `Receipt`
Return	`osid.id.IdList`		list of assignable mailbox `Ids`
Errors	NULL_ARGUMENT		`mailboxId` or `messageId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignReceiptToMailbox
Description	Adds an existing `Receipt` to a `Mailbox`.
Parameters	`osid.id.Id`	`messageId`	the `Id` of the `Receipt`
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the `Mailbox`
Errors	ALREADY_EXISTS		`messageId` is already assigned to `mailboxId`
	NOT_FOUND		`messageId` or `mailboxId` not found
	NULL_ARGUMENT		`messageId` or `mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignReceiptFromMailbox
Description	Removes a `Receipt` from a `Mailbox`.
Parameters	`osid.id.Id`	`messageId`	the `Id` of the `Receipt`
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the `Mailbox`
Errors	NOT_FOUND		`messageId` or `mailboxId` or `messageId` not assigned to `mailboxId`
	NULL_ARGUMENT		`messageId` or `mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignReceiptToMailbox
Description	Moves a `Receipt` from one `Mailbox` to another. Mappings to other `Mailboxes` are unaffected.
Parameters	`osid.id.Id`	`messageId`	the `Id` of the `Receipt`
	`osid.id.Id`	`fromMailboxId`	the `Id` of the current `Mailbox`
	`osid.id.Id`	`toMailboxId`	the `Id` of the destination `Mailbox`
Errors	ALREADY_EXISTS		`messageId` already assigned to `mailboxId`
	NOT_FOUND		`messageId, fromMailboxId`, or `toMailboxId` not found or `messageId` not mapped to `fromMailboxId`
	NULL_ARGUMENT		`messageId, fromMailboxId`, or `toMailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.