OSID - osid.messaging.MessageNotificationSession Service Interface Definition

Interface	osid.messaging.MessageNotificationSession
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 `Message` objects in this `Mailbox` . This also includes existing messages that may appear or disappear due to changes in the `Mailbox` hierarchy, 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. The two views defined in this session correspond to the views in the `MessageLookupSession` .
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	canRegisterForMessageNotifications
Description	Tests if this user can register for `Message` 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 messages 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	reliableMessageNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeMessageNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableMessageNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeMessageNotification
Description	Acknowledge a message 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	registerForNewMessages
Description	Register for notifications of new messages. `MessageReceiver.newMessages()` is invoked when a new `Message` 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	registerForNewMessagesFromSender
Description	Register for notifications of new messages from sender. `MessageReceiver.newMessages()` is invoked when a new `Message` is appears in this mailbox.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewMessagesForRecipient
Description	Register for notifications of new messages for a recipient. `MessageReceiver.newMessages()` is invoked when a new `Message` is appears in this mailbox.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMessages
Description	Registers for notification of updated messages. `MessageReceiver.changedMessages()` is invoked when a message 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	registerForChangedMessagesFromSender
Description	Register for notifications of updated messages from sender. `MessageReceiver.updatedMessages()` is invoked when a `Message` in this mailbox is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMessagesForRecipient
Description	Register for notifications of updated messages for a recipient. `MessageReceiver.updatedMessages()` is invoked when a `Message` in this mailbox is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMessage
Description	Registers for notification of an updated message. `MessageReceiver.changedMessage()` is invoked when the specified message 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	registerForDeletedMessages
Description	Registers for notification of deleted messages. `MessageReceiver.deletedMessages()` is invoked when a message 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	registerForDeletedMessagesFromSender
Description	Register for notifications of deleted messages from sender. `MessageReceiver.deletedMessages()` is invoked when a `Message` is deleted or removed from this mailbox.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedMessagesForRecipient
Description	Register for notifications of deleted messages for a recipient. `MessageReceiver.deletedMessages()` is invoked when a `Message` is deleted or removed from this mailbox.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedMessage
Description	Registers for notification of a deleted message. `MessageReceiver.deletedMessages()` is invoked when the specified message is deleted or removed from 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.