Interface | osid.voting.VoteQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
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 | getPollsId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Polls Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getPolls | ||
Description |
Gets the | ||
Return | osid.voting.Polls | the polls | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchVotes | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedPollsView | ||
Description |
Federates the view for methods in this session. A federated view will include votes in polls which are children of this polls in the polls hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedPollsView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts searches to this polls only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getVoteQuery | ||
Description |
Gets a vote query. | ||
Return | osid.voting.VoteQuery | the vote query | |
Compliance | mandatory | This method must be implemented. | |
Method | getVotesByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.voting.VoteQuery | voteQuery | the vote query |
Return | osid.voting.VoteList | the returned VoteList | |
Errors | NULL_ARGUMENT | voteQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | voteQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |