Interface | osid.commenting.BookNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the | ||
Method | canRegisterForBookNotifications | ||
Description |
Tests if this user can register for | ||
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 | ||
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 | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewBooks | ||
Description |
Register for notifications of new books. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedBooks | ||
Description |
Registers for notification of updated books. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedBook | ||
Description |
Registers for notification of an updated book. | ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedBook | ||
Description |
Registers for notification of a deleted book. | ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedBookHierarchyForAncestors | ||
Description |
Registers for notification of an updated book hierarchy
structure. | ||
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. | ||
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. |