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