Interface | osid.commenting.CommentSmartBookSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
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 associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartBooks | ||
Description |
Tests if this user can manage smart books. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart book management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommentQuery | ||
Description |
Gets a comment query. | ||
Return | osid.commenting.CommentQuery | the comment query | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommentSearchOrder | ||
Description |
Gets a comment search order. | ||
Return | osid.commenting.CommentSearchOrder | the comment search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyCommentQuery | ||
Description |
Applies a comment query to this book. | ||
Parameters | osid.commenting.CommentQuery | commentQuery | the comment query |
Errors | NULL_ARGUMENT | commentQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | commentQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectCommentQuery | ||
Description |
Gets a comment query inspector for this book. | ||
Return | osid.commenting.CommentQueryInspector | the comment query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyCommentSequencing | ||
Description |
Applies a comment search order to this book. | ||
Parameters | osid.commenting.CommentSearchOrder | commentSearchOrder | the comment search order |
Errors | NULL_ARGUMENT | commentSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | commentSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentQueryFromInspector | ||
Description |
Gets a comment query from an inspector. | ||
Parameters | osid.commenting.CommentQueryInspector | commentQueryInspector | a query inspector |
Return | osid.commenting.CommentQuery | the comment query | |
Errors | NULL_ARGUMENT | commentQueryInspector is null | |
UNSUPPORTED | commentQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |