Interface | osid.commenting.CommentSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getComments | ||
Description |
Gets the comment list resulting from a search. | ||
Return | osid.commenting.CommentList | the comment list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommentQueryInspector | ||
Description |
Gets the inspector for the query to examine the terns used in the search. | ||
Return | osid.commenting.CommentQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommentSearchResultsRecord | ||
Description |
Gets the comment search results record corresponding to
the given comment search record | ||
Parameters | osid.type.Type | commentSearchRecordType | a comment search record type |
Return | osid.commenting.records.CommentSearchResultsRecord | the comment search results record | |
Errors | NULL_ARGUMENT | commentSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(commentSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |