OSID Logo
OSID Specifications
commenting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.BookNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Book 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 Book object itself. Adding and removing comments result in notifications available from the notification session for comments.

MethodcanRegisterForBookNotifications
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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodreliableBookNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeBookNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableBookNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeBookNotification
Description

Acknowledge a book notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewBooks
Description

Register for notifications of new books. BookReceiver.newBooks() is invoked when a new Book is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBooks
Description

Registers for notification of updated books. BookReceiver.changedBooks() is invoked when a book is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBook
Description

Registers for notification of an updated book. BookReceiver.changedBooks() is invoked when the specified book is changed.

Parametersosid.id.IdbookIdthe Id of the Book to monitor
ErrorsNULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedBooks
Description

Registers for notification of deleted books. BookReceiver.deletedBooks() is invoked when a book is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedBook
Description

Registers for notification of a deleted book. BookReceiver.deletedBooks() is invoked when the specified book is deleted.

Parametersosid.id.IdbookIdthe Id of the Book to monitor
ErrorsNULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBookHierarchy
Description

Registers for notification of an updated book hierarchy structure. BookReceiver.changedChildOfBookss() is invoked when a node experiences a change in its children.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBookHierarchyForAncestors
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.

Parametersosid.id.IdbookIdthe Id of the Book node to monitor
ErrorsNULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBookHierarchyForDescendants
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.

Parametersosid.id.IdbookIdthe Id of the Book node to monitor
ErrorsNULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.