Interface | osid.voting.VoteSearchSession | ||
---|---|---|---|
Implements | osid.voting.VoteQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Votes may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getVoteSearch | ||
Description |
Gets a vote search. | ||
Return | osid.voting.VoteSearch | the vote search | |
Compliance | mandatory | This method must be implemented. | |
Method | getVoteSearchOrder | ||
Description |
Gets a vote search order. The | ||
Return | osid.voting.VoteSearchOrder | the vote search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getVotesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.voting.VoteQuery | voteQuery | the vote search query |
osid.voting.VoteSearch | voteSearch | the vote search | |
Return | osid.voting.VoteSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | voteQuery or voteSearch is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | voteSearch or voteQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getVoteQueryFromInspector | ||
Description |
Gets a vote query from an inspector. The inspector is
available from a | ||
Parameters | osid.voting.VoteQueryInspector | voteQueryInspector | a vote query inspector |
Return | osid.voting.VoteQuery | the vote query | |
Errors | NULL_ARGUMENT | voteQueryInspector is null | |
UNSUPPORTED | voteQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |