OSID - osid.forum.ForumNotificationSession Service Interface Definition

Interface	osid.forum.ForumNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Forum` objects. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. Notifications are triggered with changes to the `Forum` object itself. Adding and removing replies result in notifications available from the notification session for replies.
Method	canRegisterForForumNotifications
Description	Tests if this user can register for `Forum` 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	reliableForumNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeForumNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableForumNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeForumNotification
Description	Acknowledge a forum 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	registerForNewForums
Description	Register for notifications of new forums. `ForumReceiver.newForums()` is invoked when a new `Forum` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedForums
Description	Registers for notification of updated forums. `ForumReceiver.changedForums()` is invoked when a forum is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedForum
Description	Registers for notification of an updated forum. `ForumReceiver.changedForums()` is invoked when the specified forum is changed.
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Forum` to monitor
Errors	NULL_ARGUMENT		`forumId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedForums
Description	Registers for notification of deleted forums. `ForumReceiver.deletedForums()` is invoked when a forum is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedForum
Description	Registers for notification of a deleted forum. `ForumReceiver.deletedForums()` is invoked when the specified forum is deleted.
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Forum` to monitor
Errors	NULL_ARGUMENT		`forumId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedForumHierarchy
Description	Registers for notification of an updated forum hierarchy structure. `FroumReceiver.changedChildOfForums()` is invoked when a node 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	registerForChangedForumHierarchyForAncestors
Description	Registers for notification of an updated forum hierarchy structure. `ForumReceiver.changedChildOfForums()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Forum` node to monitor
Errors	NULL_ARGUMENT		`forumId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedForumHierarchyForDescendants
Description	Registers for notification of an updated forum hierarchy structure. `ForumReceiver.changedChildOfForums()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Forum` node to monitor
Errors	NULL_ARGUMENT		`forumId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.