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