Interface | osid.forum.ReplySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing reply searches. | ||
Method | searchAmongReplies | ||
Description |
Execute this search among the given list of replies. | ||
Parameters | osid.id.IdList | replyIds | list of replies |
Errors | NULL_ARGUMENT | replyIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderReplyResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.forum.ReplySearchOrder | replySearchOrder | reply search order |
Errors | NULL_ARGUMENT | replySearchOrder is null | |
UNSUPPORTED | replySearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getReplySearchRecord | ||
Description |
Gets the reply search record corresponding to the given
reply search record | ||
Parameters | osid.type.Type | replySearchRecordType | a reply search record type |
Return | osid.forum.records.ReplySearchRecord | the reply search record | |
Errors | NULL_ARGUMENT | replySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(replySearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |