Interface | osid.forum.ReplySearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getReplies | ||
Description |
Gets the reply list resulting from a search. | ||
Return | osid.forum.ReplyList | the reply list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getReplyQueryInspector | ||
Description |
Gets the inspector for the query to examine the terns used in the search. | ||
Return | osid.forum.ReplyQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getReplySearchResultsRecord | ||
Description |
Gets the reply search results record corresponding to
the given reply search record | ||
Parameters | osid.type.Type | replySearchRecordType | a reply search record type |
Return | osid.forum.records.ReplySearchResultsRecord | the reply search results 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. |