Interface | osid.voting.VoteSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getVotes | ||
Description |
Gets the vote list resulting from the search. | ||
Return | osid.voting.VoteList | the vote list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getVoteQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.voting.VoteQueryInspector | the vote query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getVoteSearchResultsRecord | ||
Description |
Gets the vote search results record corresponding to
the given vote search record | ||
Parameters | osid.type.Type | voteSearchRecordType | a vote search record type |
Return | osid.voting.records.VoteSearchResultsRecord | the vote search results record | |
Errors | NULL_ARGUMENT | voteSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(voteSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |