OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
voting package
Version 3.0.0
Release Candidate Preview
| Interface | osid.voting.CandidateQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Description |
This is the query inspector for examining candidate queries. | ||
| Method | getRaceIdTerms | ||
| Description |
Gets the race | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRaceTerms | ||
| Description |
Gets the race query terms. | ||
| Return | osid.voting.RaceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceTerms | ||
| Description |
Gets the resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVoteIdTerms | ||
| Description |
Gets the vote | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVoteTerms | ||
| Description |
Gets the vote query terms. | ||
| Return | osid.voting.VoteQueryInspector[] | 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 | getCandidateQueryInspectorRecord | ||
| Description |
Gets the candidate query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | candidateRecordType | a candidate record type |
| Return | osid.voting.records.CandidateQueryInspectorRecord | the candidate query inspector record | |
| Errors | NULL_ARGUMENT | candidateRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(candidateRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |