OSID - osid.messaging.ReceiptNotificationSession Service Interface Definition

Interface	osid.messaging.ReceiptNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.messaging.MessagingManager`
Used By	`osid.messaging.MessagingProxyManager`
Description	This session defines methods to receive notifications on new and changed `Receipts` in this `Mailbox` . This also includes existing receipts that may appear or disappear due to changes in the `Mailbox` hierarchy, This session is intended for consumers needing to synchronize their receipts with this service without the use of polling. Notifications are cancelled when this session is closed. The two views defined in this session correspond to the views in the `ReceiptLookupSession` .
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	canRegisterForReceiptNotifications
Description	Tests if this user can register for `Receipt` notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 notification operations.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedMailboxView
Description	Federates the view for methods in this session. A federated view will include receipts in mailboxes which are children of this mailbox in the mailbox hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedMailboxView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this mailbox only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableReceiptNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeReceiptNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableReceiptNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeReceiptNotification
Description	Acknowledge a receipt notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewReceipts
Description	Register for notifications of new receipts. `ReceiptReceiver.newReceipts()` is invoked when a new `Receipt` is appears in this mailbox.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewReceiptsForMessage
Description	Register for notifications of new receipts for the specified message. `ReceiptReceiver.newReceipts()` is invoked when a new `Receipt` is appears in this mailbox.
Parameters	`osid.id.Id`	`messageId`	the `Id` of the `Message` to monitor
Errors	NULL_ARGUMENT		`messageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewReceiptsByRecipient
Description	Register for notifications of new receipts for the specified recipient. `ReceiptReceiver.newReceipst()` is invoked when a new `Receipt` is appears in this mailbox.
Parameters	`osid.id.Id`	`recipientId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`recipientId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedReceipts
Description	Registers for notification of updated receipts. `ReceiptReceiver.changedReceipts()` is invoked when a receipt in this mailbox is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedReceiptsForMessage
Description	Register for notifications of updated receipts for the specified message. `ReceiptReceiver.changedReceipts()` is invoked when a `Receipt` in this mailbox is changed.
Parameters	`osid.id.Id`	`messageId`	the `Id` of the `Message` to monitor
Errors	NULL_ARGUMENT		`messageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedReceiptsByRecipient
Description	Register for notifications of updated receipts for the specified recipient. `ReceiptReceiver.changedReceipts()` is invoked when a `Receipt` in this mailbox is changed.
Parameters	`osid.id.Id`	`recipientId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`recipientId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedReceipt
Description	Registers for notification of an updated receipt. `ReceiptReceiver.changedReceipt()` is invoked when the specified receipt in this mailbox is changed.
Parameters	`osid.id.Id`	`receiptId`	the `Id` of the `Receipt` to monitor
Errors	NULL_ARGUMENT		`receiptId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedReceipts
Description	Registers for notification of receipts whose messages have been deleted or removed from this mailbox. `ReceiptReceiver.deletedReceipts()` is invoked when a receipt is deleted or removed from this mailbox.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedReceiptsForMessage
Description	Register for notifications of deleted receipts for the specified message. `ReceiptReceiver.deletedReceipts()` is invoked when a `Receipt` in this mailbox is removed.
Parameters	`osid.id.Id`	`messageId`	the `Id` of the `Message` to monitor
Errors	NULL_ARGUMENT		`messageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedReceiptsByRecipient
Description	Register for notifications of deleted receipts for the specified recipient. `ReceiptReceiver.deletedReceipts()` is invoked when a `Receipt` in this mailbox is removed.
Parameters	`osid.id.Id`	`recipientId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`recipientId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedReceipt
Description	Registers for notification of a deleted receipt. `MessageReceiver.deletedReceipts()` is invoked when the specified receipt is deleted or removed from this mailbox.
Parameters	`osid.id.Id`	`receiptId`	the `Id` of the `Receipt` to monitor
Errors	NULL_ARGUMENT		`receiptId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.