OSID - osid.messaging.MailboxNotificationSession Service Interface Definition

Interface	osid.messaging.MailboxNotificationSession
Implements	`osid.OsidSession`
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	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	registerForNewMailboxAncestors
Description	Registers for notification if an ancestor is added to the specified mailbox in the mailbox hierarchy. `MailboxReceiver.newMailboxAncestor()` is invoked when the specified mailbox experiences an addition in ancestry.
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	registerForNewMailboxDescendants
Description	Registers for notification if a descendant is added to the specified mailbox in the mailbox hierarchy. `MailboxReceiver.newMailboxDescendant()` is invoked when the specified mailbox experiences an addition in descendants.
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	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	registerForDeletedMailboxAncestors
Description	Registers for notification if an ancestor is removed from the specified mailbox in the mailbox hierarchy. `MailboxReceiver.deletedMailboxAncestor()` is invoked when the specified mailbox experiences a removal of an ancestor.
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	registerForDeletedMailboxDescendants
Description	Registers for notification if a descendant is removed from fthe specified mailbox in the mailbox hierarchy. `MailboxReceiver.deletedMailboxDescednant()` is invoked when the specified mailbox experiences a removal of one of its descdendents.
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.