OSID Specifications
voting package
Version 3.0.0
voting package
Version 3.0.0
| Interface | osid.voting.VoteQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Used By | osid.voting.CandidateQueryInspector | ||
osid.voting.VoteSearchResults | |||
osid.voting.VoteSmartPollsSession | |||
osid.voting.rules.VoteEnablerQueryInspector | |||
| Description |
This is the query inspector for examining vote queries. | ||
| Method | getCandidateIdTerms | ||
| Description |
Gets the candidate | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCandidateTerms | ||
| Description |
Gets the candidate query terms. | ||
| Return | osid.voting.CandidateQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVoterIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVoterTerms | ||
| Description |
Gets the resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVotingAgentIdTerms | ||
| Description |
Gets the voting agent | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVotingAgentTerms | ||
| Description |
Gets the voting agent query terms. | ||
| Return | osid.authentication.AgentQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVotesTerms | ||
| Description |
Gets the votes query terms. | ||
| Return | osid.search.terms.IntegerRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMinimumVotesTerms | ||
| Description |
Gets the minimum votes query terms. | ||
| Return | osid.search.terms.IntegerTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPollsIdTerms | ||
| Description |
Gets the polls | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPollsTerms | ||
| Description |
Gets the polls query terms. | ||
| Return | osid.voting.PollsQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVoteQueryInspectorRecord | ||
| Description |
Gets the vote query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | voteRecordType | a vote record type |
| Return | osid.voting.records.VoteQueryInspectorRecord | the vote query inspector record | |
| Errors | NULL_ARGUMENT | voteRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(voteRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |