Interface | osid.voting.rules.BallotConstrainerEnablerRuleLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
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 | canLookupBallotConstrainerEnablerRules | ||
Description |
Tests if this user can perform lookups of ballot
constrainer enabler/ballot constrainer mappings. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known lookup methods
in this session will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeBallotConstrainerEnablerRuleView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryBallotConstrainerEnablerRuleView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedPollsView | ||
Description |
Federates the view for methods in this session. A federated view will include ballot constrainer enablers in polls which are children of this polls in the polls hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedPollsView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this polls only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getBallotConstrainerEnablerIdsForBallotConstrainer | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ballotConstrainerId | Id of the BallotConstrainer |
Return | osid.id.IdList | the ballot constrainer enabler Ids | |
Errors | NOT_FOUND | ballotConstrainerId is not found | |
NULL_ARGUMENT | ballotConstrainerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBallotConstrainerEnablersForBallotConstrainer | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ballotConstrainerId | Id of the BallotConstrainer |
Return | osid.voting.rules.BallotConstrainerEnablerList | the ballot constrainer enablers | |
Errors | NOT_FOUND | ballotConstrainerId is not found | |
NULL_ARGUMENT | ballotConstrainerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBallotConstrainerIdsForBallotConstrainerEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ballotConstrainerEnablerId | Id of a BallotConstrainerEnabler |
Return | osid.id.IdList | list of ballot constrainer Ids | |
Errors | NOT_FOUND | ballotConstrainerEnablerId is not found | |
NULL_ARGUMENT | ballotConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBallotConstrainersForBallotConstrainerEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ballotConstrainerEnablerId | Id of a BallotConstrainerEnabler |
Return | osid.voting.rules.BallotConstrainerList | list of ballot constrainers | |
Errors | NOT_FOUND | ballotConstrainerEnablerId is not found | |
NULL_ARGUMENT | ballotConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |