OSID - osid.forum.ReplyNotificationSession Service Interface Definition

Interface	osid.forum.ReplyNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.forum.ForumManager`
Used By	`osid.forum.ForumProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Reply` 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.
Method	getForumId
Description	Gets the `Forum` `Id` associated with this session.
Return	`osid.id.Id`		the `Forum Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getForum
Description	Gets the `Forum` associated with this session.
Return	`osid.forum.Forum`		the forum
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForReplyNotifications
Description	Tests if this user can register for `Reply` 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	useFederatedForumView
Description	Federates the view for methods in this session. A federated view will include notifications for replies in forums which are children of this forum in the forum hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedForumView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this forum only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableReplyNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeReplyNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableReplyNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeReplyNotification
Description	Acknowledge a reply 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	registerForNewReplies
Description	Register for notifications of new replies. `ReplyReceiver.newReplies()` is invoked when a new `Reply` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRepliesForPoster
Description	Register for notifications of new replies for the given poster resource `Id`. `ReplyReceiver.newReplies()` is invoked when a new `Reply` is created.
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	registerForNewRepliesForPost
Description	Register for notifications of new replies for the given post `Id`. `ReplyReceiver.newReplies()` is invoked when a new `Reply` is created.
Parameters	`osid.id.Id`	`postId`	the `Id` of the post to monitor
Errors	NULL_ARGUMENT		`postId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedReplies
Description	Registers for notification of updated replies. `ReplyReceiver.changedReplies()` is invoked when a reply is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRepliesForPoster
Description	Register for notifications of changed replies for the given poster resource `Id`. `ReplyReceiver.changedReplies()` is invoked when a `Reply` for the poster 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	registerForChangedRepliesForPost
Description	Register for notifications of changed replies for the given post `Id`. `ReplyReceiver.changedReplies()` is invoked when a `Reply` for the post is changed.
Parameters	`osid.id.Id`	`postId`	the `Id` of the post to monitor
Errors	NULL_ARGUMENT		`postId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedReply
Description	Registers for notification of an updated reply. `ReplyReceiver.changedReplies()` is invoked when the specified reply is changed.
Parameters	`osid.id.Id`	`replyId`	the `Id` of the `Reply` to monitor
Errors	NULL_ARGUMENT		`replyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedReplies
Description	Registers for notification of deleted replies. `ReplyReceiver.deletedReplies()` is invoked when a reply is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRepliesForPoster
Description	Register for notifications of deleted replies for the given poster resource `Id`. `ReplyReceiver.deletedReplies()` is invoked when a `Reply` for the poster is deleted.
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	registerForDeletedRepliesForPost
Description	Register for notifications of deleted replies for the given post `Id`. `ReplyReceiver.deletedReplies()` is invoked when a `Reply` for the post is deleted.
Parameters	`osid.id.Id`	`postId`	the `Id` of the post to monitor
Errors	NULL_ARGUMENT		`postId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedReply
Description	Registers for notification of a deleted reply. `ReplyReceiver.deletedReplies()` is invoked when the specified reply is deleted.
Parameters	`osid.id.Id`	`replyId`	the `Id` of the `Reply` to monitor
Errors	NULL_ARGUMENT		`replyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.