OSID - osid.commenting.CommentNotificationSession Service Interface Definition

Interface	osid.commenting.CommentNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.commenting.CommentingManager`
Used By	`osid.commenting.CommentingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Comments`. 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	getBookId
Description	Gets the `Book` `Id` associated with this session.
Return	`osid.id.Id`		the `Book Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBook
Description	Gets the `Book` associated with this session.
Return	`osid.commenting.Book`		the book
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForCommentNotifications
Description	Tests if this user can register for `Comment` 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	useFederatedBookView
Description	Federates the view for methods in this session. A federated view will include notifications for commentss in books which are children of this book in the book hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBookView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this book only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableCommentNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCommentNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCommentNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCommentNotification
Description	Acknowledge a comment 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	registerForNewComments
Description	Register for notifications of new comments. `CommentReceiver.newComments()` is invoked when a new `Comment` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCommentsForCommentor
Description	Register for notifications of new comments by the given resource `Id`. `CommentReceiver.newComments()` is invoked when a new `Comment` 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	registerForNewCommentsForReference
Description	Register for notifications of new comments for the given reference `Id`. `CommentReceiver.newComments()` is invoked when a new `Comment` is created.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference to monitor
Errors	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedComments
Description	Registers for notification of updated comments. `CommentReceiver.changedComments()` is invoked when a comment is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCommentsForCommentor
Description	Register for notifications of changed comments by the given resource `Id`. `CommentReceiver.changedComments()` is invoked when a `Comment` by the resource 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	registerForChangedCommentsForReference
Description	Register for notifications of changed comments for the given reference `Id`. `CommentReceiver.changedComments()` is invoked when a `Comment` for the reference is changed.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference to monitor
Errors	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedComment
Description	Registers for notification of an updated comment. `CommentReceiver.changedComments()` is invoked when the specified comment is changed.
Parameters	`osid.id.Id`	`commentId`	the `Id` of the `Comment` to monitor
Errors	NOT_FOUND		a comment was not found identified by the given `Id`
	NULL_ARGUMENT		`commentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedComments
Description	Registers for notification of deleted comments. `CommentReceiver.deletedComments()` is invoked when a comment is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCommentsForCommentor
Description	Register for notifications of deleted comments by the given resource `Id`. `CommentReceiver.deletedComments()` is invoked when a `Comment` by the resource 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	registerForDeletedCommentsForReference
Description	Register for notifications of deleted comments for the given reference `Id`. `CommentReceiver.deletedComments()` is invoked when a `Comment` for the reference is deleted.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference to monitor
Errors	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedComment
Description	Registers for notification of a deleted comment. `CommentReceiver.deletedComments()` is invoked when the specified comment is deleted.
Parameters	`osid.id.Id`	`commentId`	the `Id` of the `Comment` to monitor
Errors	NOT_FOUND		a comment was not found identified by the given `Id`
	NULL_ARGUMENT		`commentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.