OSID - osid.messaging.MailboxNotificationSession Service Interface Definition

Interface	osid.messaging.MailboxNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.messaging.MessagingManager`
Used By	`osid.messaging.MessagingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Mailbox` objects. This session is intended for consumers needing to synchronize their message with this service without the use of polling. Notifications are cancelled when this session is closed.
Method	canRegisterForMailboxNotifications
Description	Tests if this user can register for `Mailbox` 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	reliableMailboxNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeMailboxNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableMailboxNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeMailboxNotification
Description	Acknowledge a mailbox 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	registerForNewMailboxes
Description	Register for notifications of new mailboxes. `MailboxReceiver.newMailboxes()` is invoked when a new `Mailbox` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMailboxes
Description	Registers for notification of updated mailboxes. `MailboxReceiver.changedMailboxes()` is invoked when a mailbox is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMailbox
Description	Registers for notification of an updated mailbox. `MailboxReceiver.changedMailboxes()` is invoked when the specified mailbox is changed.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the Mailbox to monitor
Errors	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedMailboxes
Description	Registers for notification of deleted mailboxes. `MailboxReceiver.deletedMailboxes()` is invoked when a mailbox is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedMailbox
Description	Registers for notification of a deleted mailbox. `MailboxReceiver.deletedMailboxes()` is invoked when the specified mailbox is deleted.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the `Mailbox` to monitor
Errors	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMailboxHierarchy
Description	Registers for notification of an updated mailbox hierarchy structure. `MailboxReceiver.changedChildOfMailboxess()` is invoked when the specified node or any of its descendants experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMailboxHierarchyForAncestors
Description	Registers for notification of an updated mailbox hierarchy structure. `MailboxReceiver.changedChildOfMailboxess()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the `Mailbox` node to monitor
Errors	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMailboxHierarchyForDescendants
Description	Registers for notification of an updated mailbox hierarchy structure. `MailboxReceiver.changedChildOfMailboxess()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the `Mailbox` node to monitor
Errors	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.