OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
voting package
Version 3.0.0
Release Candidate Preview
| Interface | osid.voting.BallotAuthoringSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods for authoring ballots. | ||
| Method | getBallotId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Ballot Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBallot | ||
| Description |
Gets the | ||
| Return | osid.voting.Ballot | the Ballot associated with this session | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canAuthorBallots | ||
| Description |
Tests if this user can perform author ballots. 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 lookup methods are not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRaces | ||
| Description |
Gets the races on this ballot. | ||
| Return | osid.voting.RaceList | the races | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | addRace | ||
| Description |
Adds a race to this ballot. | ||
| Parameters | osid.id.Id | raceId | the Id of the Race |
| Errors | ALREADY_EXISTS | raceId already in ballot | |
| NOT_FOUND | raceId not found | ||
| NULL_ARGUMENT | raceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRace | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | raceId | the Id of the Race |
| Errors | NOT_FOUND | raceId not in ballot | |
| NULL_ARGUMENT | raceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveRace | ||
| Description |
Moves an existing race to follow another race in this ballot. | ||
| Parameters | osid.id.Id | raceId | the Id of a Race |
osid.id.Id | preceedingRaceId | the Id of a preceeding Race in the sequence | |
| Errors | NOT_FOUND | raceId or preceedingRaceId is not found | |
| NULL_ARGUMENT | raceId or preceedingRaceId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderRaces | ||
| Description |
Sequences existing races on this ballot. | ||
| Parameters | osid.id.Id[] | raceIds | the Id of the Races |
| Errors | NOT_FOUND | a raceId was not found | |
| NULL_ARGUMENT | raceIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| Compliance | mandatory | This method must be implemented. | |