| Interface | osid.voting.rules.RaceConstrainerPollsAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignRaceConstrainers | ||
| Description |
Tests if this user can alter race constrainer/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 | canAssignRaceConstrainersToPolls | ||
| Description |
Tests if this user can alter race constrainer/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 constrainer 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 | getAssignablePollsIdsForRaceConstrainer | ||
| Description |
Gets a list of polls including and under the given polls node in which a specific race constrainer can be assigned. | ||
| Parameters | osid.id.Id | pollsId | the Id of the Polls |
osid.id.Id | raceConstrainerId | the Id of the RaceConstrainer | |
| Return | osid.id.IdList | list of assignable polls Ids | |
| Errors | NULL_ARGUMENT | pollsId or raceConstrainerId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignRaceConstrainerToPolls | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | raceConstrainerId | the Id of the RaceConstrainer |
osid.id.Id | pollsId | the Id of the Polls | |
| Errors | ALREADY_EXISTS | raceConstrainerId is already assigned to pollsId
| |
| NOT_FOUND | raceConstrainerId or pollsId not found | ||
| NULL_ARGUMENT | raceConstrainerId or pollsId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignRaceConstrainerFromPolls | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | raceConstrainerId | the Id of the RaceConstrainer |
osid.id.Id | pollsId | the Id of the Polls | |
| Errors | NOT_FOUND | raceConstrainerId or pollsId not found or
raceConstrainerId not assigned to pollsId | |
| NULL_ARGUMENT | raceConstrainerId or pollsId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignRaceConstrainerToPolls | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | raceConstrainerId | the Id of the RaceConstrainer |
osid.id.Id | fromPollsId | the Id of the current Polls | |
osid.id.Id | toPollsId | the Id of the destination Polls | |
| Errors | NOT_FOUND | raceConstrainerId, fromPollsId, or toPollsId
not found or raceConstrainerId not mapped to fromPollsId
| |
| NULL_ARGUMENT | raceConstrainerId, fromPollsId, or toPollsId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |