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