| Interface | osid.voting.RacePollsAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.voting.VotingManager | ||
osid.voting.VotingProxyManager | |||
| Description |
This session provides methods to re-assign
Moving or adding a reference of a | ||
| Method | canAssignRaces | ||
| Description |
Tests if this user can alter race/polls mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignRacesToPolls | ||
| Description |
Tests if this user can alter race/polls mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
| Parameters | osid.id.Id | pollsId | the Id of the Polls |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | pollsId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignablePollsIds | ||
| Description |
Gets a list of polls including and under the given polls node in which any race can be assigned. | ||
| Parameters | osid.id.Id | pollsId | the Id of the Polls |
| Return | osid.id.IdList | list of assignable polls Ids | |
| Errors | NULL_ARGUMENT | pollsId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignablePollsIdsForRace | ||
| Description |
Gets a list of polls including and under the given polls node in which a specific race can be assigned. | ||
| Parameters | osid.id.Id | pollsId | the Id of the Polls |
osid.id.Id | raceId | the Id of the Race | |
| Return | osid.id.IdList | list of assignable polls Ids | |
| Errors | NULL_ARGUMENT | polls or raceId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignRaceToPolls | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | raceId | the Id of the Race |
osid.id.Id | pollsId | the Id of the Polls | |
| Errors | ALREADY_EXISTS | raceId is already assigned to pollsId | |
| NOT_FOUND | raceId or pollsId not found | ||
| NULL_ARGUMENT | raceId or pollsId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignRaceFromPolls | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | raceId | the Id of the Race |
osid.id.Id | pollsId | the Id of the Polls | |
| Errors | NOT_FOUND | raceId or pollsId not found or
raceId not assigned to pollsId | |
| NULL_ARGUMENT | raceId or pollsId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignRaceToPolls | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | raceId | the Id of the Race |
osid.id.Id | fromPollsId | the Id of the current Polls | |
osid.id.Id | toPollsId | the Id of the destination Polls | |
| Errors | ALREADY_EXISTS | raceId already assigned to toPollsId | |
| NOT_FOUND | raceId, fromPollsId , or toPollsId not found or
raceId not mapped to fromPollsId | ||
| NULL_ARGUMENT | raceId, fromPollsId , or toPollsId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |