Interface | osid.commenting.CommentSearchSession | ||
---|---|---|---|
Implements | osid.commenting.CommentQuerySession | ||
Description |
This session provides methods for searching Comments may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getCommentSearch | ||
Description |
Gets a comment search. | ||
Return | osid.commenting.CommentSearch | the comment search | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommentSearchOrder | ||
Description |
Gets a comment search order. The | ||
Return | osid.commenting.CommentSearchOrder | the comment search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.commenting.CommentQuery | commentQuery | the comment query |
osid.commenting.CommentSearch | commentSearch | the comment search | |
Return | osid.commenting.CommentSearchResults | the search results | |
Errors | NULL_ARGUMENT | commentQuery or commentSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | commentQuery or commentSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentQueryFromInspector | ||
Description |
Gets an entry query from an inspector. The inspector is
available from an | ||
Parameters | osid.commenting.CommentQueryInspector | commentQueryInspector | a comment query inspector |
Return | osid.commenting.CommentQuery | the entry query | |
Errors | NULL_ARGUMENT | commentQueryInspector is null | |
UNSUPPORTED | commentQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |