Interface | osid.commenting.CommentNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | getBookId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Book Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBook | ||
Description |
Gets the | ||
Return | osid.commenting.Book | the book | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForCommentNotifications | ||
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 | 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 | ||
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 | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewComments | ||
Description |
Register for notifications of new comments. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewCommentsForCommentor | ||
Description |
Register for notifications of new comments by the given
resource | ||
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 | ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCommentsForCommentor | ||
Description |
Register for notifications of changed comments by the
given resource | ||
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 | ||
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.
| ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCommentsForCommentor | ||
Description |
Register for notifications of deleted comments by the
given resource | ||
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 | ||
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. | ||
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. |