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