OSID - osid.commenting.BookNotificationSession Service Interface Definition

Interface	osid.commenting.BookNotificationSession
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 `Books`. 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 `Book` object itself. Adding and removing comments result in notifications available from the notification session for comments.
Method	canRegisterForBookNotifications
Description	Tests if this user can register for `Book` 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	reliableBookNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeBookNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableBookNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeBookNotification
Description	Acknowledge a book 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	registerForNewBooks
Description	Register for notifications of new books. `BookReceiver.newBooks()` is invoked when a new `Book` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBooks
Description	Registers for notification of updated books. `BookReceiver.changedBooks()` is invoked when a book is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBook
Description	Registers for notification of an updated book. `BookReceiver.changedBooks()` is invoked when the specified book is changed.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book` to monitor
Errors	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBooks
Description	Registers for notification of deleted books. `BookReceiver.deletedBooks()` is invoked when a book is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBook
Description	Registers for notification of a deleted book. `BookReceiver.deletedBooks()` is invoked when the specified book is deleted.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book` to monitor
Errors	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBookHierarchy
Description	Registers for notification of an updated book hierarchy structure. `BookReceiver.changedChildOfBookss()` 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	registerForChangedBookHierarchyForAncestors
Description	Registers for notification of an updated book hierarchy structure. `BookReceiver.changedChildOfBooks()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book` node to monitor
Errors	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBookHierarchyForDescendants
Description	Registers for notification of an updated book hierarchy structure. `BookReceiver.changedChildOfBooks()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book` node to monitor
Errors	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.