Interface | osid.voting.rules.BallotConstrainerEnablerRuleApplicationSession | ||
---|---|---|---|
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 | canAssignBallotConstrainerEnablers | ||
Description |
Tests if this user can alter ballot constrainer
enabler/ballot constrainer 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 | assignBallotConstrainerEnablerToBallotConstrainer | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | ballotConstrainerEnablerId | the Id of the BallotConstrainerEnabler |
osid.id.Id | ballotConstrainerId | the Id of the BallotConstrainer | |
Errors | ALREADY_EXISTS | ballotConstrainerEnablerId is already applied to
ballotConstrainerId | |
NOT_FOUND | ballotConstrainerEnablerId or ballotConstrainerId
not found | ||
NULL_ARGUMENT | ballotConstrainerEnablerId or ballotConstrainerId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignBallotConstrainerEnablerFromBallotConstrainer | ||
Description |
Removes a | ||
Parameters | osid.id.Id | ballotConstrainerEnablerId | the Id of the BallotConstrainerEnabler |
osid.id.Id | ballotConstrainerId | the Id of the BallotConstrainer | |
Errors | NOT_FOUND | ballotConstrainerEnablerId or ballotConstrainerId
not found or ballotConstrainerEnablerId not applied to
ballotConstrainerId | |
NULL_ARGUMENT | ballotConstrainerEnablerId or ballotConstrainerId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceBallotConstrainerEnablers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if BallotConstrainerEnabler ordering is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveBallotConstrainerEnablerAhead | ||
Description |
Reorders ballot constrainer enablers for a ballot constrainer by moving the specified ballot constrainer enabler in front of a reference ballot constrainer enabler. | ||
Parameters | osid.id.Id | ballotConstrainerEnablerId | the Id of a BallotConstrainerEnabler |
osid.id.Id | ballotConstrainerId | the Id of a BallotConstrainer | |
osid.id.Id | referenceId | the reference ballot constrainer enabler Id | |
Errors | NOT_FOUND | ballotConstrainerEnablerId, ballotConstrainerId, or
referenceId not found or, ballotConstrainerId or
referenceId not related to ballotConstrainerId | |
NULL_ARGUMENT | ballotConstrainerEnablerId, ballotConstrainerId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveBallotConstrainerEnablerBehind | ||
Description |
Reorders ballot constrainer enablers for a ballot constrainer by moving the specified ballot constrainer enabler behind a reference ballot constrainer enabler. | ||
Parameters | osid.id.Id | ballotConstrainerEnablerId | the Id of a BallotConstrainerEnabler |
osid.id.Id | ballotConstrainerId | the Id of a BallotConstrainer | |
osid.id.Id | referenceId | the reference ballot constrainer enabler Id | |
Errors | NOT_FOUND | ballotConstrainerEnablerId, ballotConstrainerId, or
referenceId not found or, ballotConstrainerId or
referenceId not related to ballotConstrainerId | |
NULL_ARGUMENT | ballotConstrainerEnablerId, ballotConstrainerId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderBallotConstrainerEnablers | ||
Description |
Reorders a set of ballot constrainer enablers for a ballot constrainer. | ||
Parameters | osid.id.Id[] | ballotConstrainerEnablerIds | the Ids for a set of BallotConstrainerEnablers
|
osid.id.Id | ballotConstrainerId | the Id of a BallotConstrainer | |
Errors | NOT_FOUND | ballotConstrainerId not found or, a
ballotConstrainerEnablerId not related to ballotConstrainerId
| |
NULL_ARGUMENT | ballotConstrainerEnablerIds or ballotConstrainerId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |