Interface | osid.voting.rules.BallotConstrainerRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
Method | getPollsId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Polls Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getPolls | ||
Description |
Gets the | ||
Return | osid.voting.Polls | the polls | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAssignBallotConstrainers | ||
Description |
Tests if this user can alter ballot constrainer/ballot
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 | assignBallotConstrainerToBallot | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | ballotConstrainerId | the Id of the BallotConstrainer |
osid.id.Id | ballotId | the Id of the Ballot | |
Errors | ALREADY_EXISTS | ballotConstrainerId is already applied to ballotId
| |
NOT_FOUND | ballotConstrainerId or ballotId not found | ||
NULL_ARGUMENT | ballotConstrainerId or ballotId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignBallotConstrainerFromBallot | ||
Description |
Removes a | ||
Parameters | osid.id.Id | ballotConstrainerId | the Id of the BallotConstrainer |
osid.id.Id | ballotId | the Id of the Ballot | |
Errors | NOT_FOUND | ballotConstrainerId or ballotId not found or
ballotConstrainerId not applied to ballotId | |
NULL_ARGUMENT | ballotConstrainerId or ballotId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceBallotConstrainers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if BallotConstrainer ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveBallotConstrainerAhead | ||
Description |
Reorders ballot constrainer for a ballot by moving the specified ballot constrainer in front of a reference ballot constrainer. | ||
Parameters | osid.id.Id | ballotConstrainerId | the Id of a BallotConstrainer |
osid.id.Id | ballotId | the Id of a Ballot | |
osid.id.Id | referenceId | the reference ballot constrainer Id | |
Errors | NOT_FOUND | ballotConstrainerId, ballotId, or referenceId
not found or, ballotConstrainerId or referenceId
not related to ballotId | |
NULL_ARGUMENT | ballotConstrainerId, ballotId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveBallotConstrainerBehind | ||
Description |
Reorders ballot constrainer for a ballot by moving the specified ballot constrainer behind a reference ballot constrainer. | ||
Parameters | osid.id.Id | ballotConstrainerId | the Id of a BallotConstrainer |
osid.id.Id | ballotId | the Id of a Ballot | |
osid.id.Id | referenceId | the reference ballot constrainer Id | |
Errors | NOT_FOUND | ballotConstrainerId, ballotId, or referenceId
not found or, ballotConstrainerId or referenceId
not related to ballotId | |
NULL_ARGUMENT | ballotConstrainerId, ballotId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderBallotConstrainers | ||
Description |
Reorders a set of ballot constrainers for a ballot | ||
Parameters | osid.id.Id[] | ballotConstrainerIds | the Ids for a set of BallotConstrainer |
osid.id.Id | ballotId | the Id of a Ballot | |
Errors | NOT_FOUND | ballotId not found or, a ballotConstrainerId
not related to ballotId | |
NULL_ARGUMENT | ballotConstrainerIds or ballotId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |