| Interface | osid.commenting.CommentSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing comment searches. | ||
| Method | searchAmongComments | ||
| Description |
Execute this search among the given list of comments. | ||
| Parameters | osid.id.IdList | commentIds | list of comments |
| Errors | NULL_ARGUMENT | commentIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCommentResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.commenting.CommentSearchOrder | commentSearchOrder | comment search order |
| Errors | NULL_ARGUMENT | commentSearchOrder is null | |
| UNSUPPORTED | commentSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommentSearchRecord | ||
| Description |
Gets the comment search record corresponding to the
given comment search record | ||
| Parameters | osid.type.Type | commentSearchRecordType | a comment search record type |
| Return | osid.commenting.records.CommentSearchRecord | the comment search 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. | |