OSID Specifications
voting package
Version 3.0.0
voting package
Version 3.0.0
| Interface | osid.voting.RaceResultsSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.voting.VotingManager | ||
osid.voting.VotingProxyManager | |||
| Description |
This session provides methods for examining voting results. | ||
| 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 | isOpen | ||
| Description |
Tests if this ballot is still open. | ||
| Return | boolean | true if the ballot is open, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canExamineRaceResults | ||
| Description |
Tests if this user can examine race results. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known all methods in
this session will result in a
| ||
| Return | boolean | false if race results methods are not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRaceResultsForBalot | ||
| Description |
Gets all race results on a ballot. | ||
| Parameters | osid.id.Id | ballotId | Id of the Ballot |
| Return | osid.voting.RaceResultList | the race results | |
| Errors | NOT_FOUND | ballotId not found | |
| NULL_ARGUMENT | ballotId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getWinningRaceResultsForBallot | ||
| Description |
Gets the winning race results for each race on a ballot. | ||
| Parameters | osid.id.Id | ballotId | Id of the Ballot |
| Return | osid.voting.RaceResultList | the race results | |
| Errors | NOT_FOUND | ballotId not found | |
| NULL_ARGUMENT | ballotId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getRaceResultsForRace | ||
| Description |
Gets all race results in a race ordered from the most votes to the fewest votes. | ||
| Parameters | osid.id.Id | raceId | Id of the Race |
| Return | osid.voting.RaceResultList | the race results | |
| Errors | NOT_FOUND | raceId not found | |
| NULL_ARGUMENT | raceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getWinningRaceResultsForRace | ||
| Description |
Gets the winning race results in a race. | ||
| Parameters | osid.id.Id | raceId | Id of the Race |
| Return | osid.voting.RaceResultList | the race results | |
| Errors | NOT_FOUND | raceId not found | |
| NULL_ARGUMENT | raceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getRaceResultsForCandidate | ||
| Description |
Gets the race results for a candidate in a race. | ||
| Parameters | osid.id.Id | raceId | Id of the Race |
osid.id.Id | candidateId | Id of the Candidate | |
| Return | osid.voting.RaceResultList | the race results | |
| Errors | NOT_FOUND | candidateId not in raceId | |
| NULL_ARGUMENT | raceId or candidateId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getRaceResultsByVoter | ||
| Description |
Gets all race results on this ballot by voter. | ||
| Parameters | osid.id.Id | resourceId | Id of a Resource |
| Return | osid.voting.RaceResultList | the race results | |
| Errors | NOT_FOUND | resourceId not found | |
| NULL_ARGUMENT | resourceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getTopRaceResultsByVoter | ||
| Description |
Gets the top race results for each race by voter, | ||
| Parameters | osid.id.Id | resourceId | Id of a Resource |
| Return | osid.voting.RaceResultList | the race results | |
| Errors | NOT_FOUND | resourceId not found | |
| NULL_ARGUMENT | resourceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getRaceResultsByVoterForRace | ||
| Description |
Gets all race results by a resource in a race ordered from the most votes to the fewest votes. | ||
| Parameters | osid.id.Id | raceId | Id of the Race |
osid.id.Id | resourceId | Id of a Resource | |
| Return | osid.voting.RaceResultList | the race results | |
| Errors | NOT_FOUND | raceId not found | |
| NULL_ARGUMENT | raceId or resourceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getWinningRaceResultsByVoterForRace | ||
| Description |
Gets the winning race results by a resource in a race ordered from the most votes to the fewest votes. | ||
| Parameters | osid.id.Id | raceId | Id of the Race |
osid.id.Id | resourceId | Id of a Resource | |
| Return | osid.voting.RaceResultList | the race results | |
| Errors | NOT_FOUND | raceId not found | |
| NULL_ARGUMENT | raceId or resourceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getRaceResultsByVoterForCandidate | ||
| Description |
Gets the race results by voter for a candidate in a race. | ||
| Parameters | osid.id.Id | raceId | Id of the Race |
osid.id.Id | candidateId | Id of the Candidate | |
osid.id.Id | resourceId | Id of a Resource | |
| Return | osid.voting.RaceResultList | the race results | |
| Errors | NOT_FOUND | candidateId not in raceId | |
| NULL_ARGUMENT | raceId , candidateId or resourceId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method is must be implemented. | |