OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.BallotConstrainerEnablerRuleLookupSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve BallotConstrainerEnabler to BallotConstrainer mappings. A BallotConstrainer with multiple BallotConstrainerEnablers means any positive rule evaluation across the enablers result in an effective BallotConstrainer.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated polls view: All methods in this session operate, retrieve and pertain ballot constrainer enablers defined explicitly in the current polls
  • federated polls view: All methods in this session operate, retrieve and pertain to all ballot constrainer enablers defined in this polls and any other ballot constrainer enablers implicitly available in this polls through polls inheritence.
MethodgetPollsId
Description

Gets the Polls Id associated with this session.

Returnosid.id.Idthe Polls Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetPolls
Description

Gets the Polls associated with this session.

Returnosid.voting.Pollsthe polls
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupBallotConstrainerEnablerRules
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBallotConstrainerEnablerRuleView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryBallotConstrainerEnablerRuleView
Description

A complete view of the BallotConstrainerEnabler and BallotConstrainer returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedPollsView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedPollsView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this polls only.

CompliancemandatoryThis method is must be implemented.
MethodgetBallotConstrainerEnablerIdsForBallotConstrainer
Description

Gets the BallotConstrainerEnabler Id associated with a BallotConstrainer.

Parametersosid.id.Id ballotConstrainerId Id of the BallotConstrainer
Returnosid.id.IdListthe ballot constrainer enabler Ids
ErrorsNOT_FOUND ballotConstrainerId is not found
NULL_ARGUMENT ballotConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerEnablersForBallotConstrainer
Description

Gets the BallotConstrainerEnablers associated with a BallotConstrainer.

Parametersosid.id.IdballotConstrainerId Id of the BallotConstrainer
Returnosid.voting.rules.BallotConstrainerEnablerListthe ballot constrainer enablers
ErrorsNOT_FOUND ballotConstrainerId is not found
NULL_ARGUMENT ballotConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerIdsForBallotConstrainerEnabler
Description

Gets the BallotConstrainer Ids mapped to a BallotConstrainerEnabler.

Parametersosid.id.IdballotConstrainerEnablerId Id of a BallotConstrainerEnabler
Returnosid.id.IdListlist of ballot constrainer Ids
ErrorsNOT_FOUND ballotConstrainerEnablerId is not found
NULL_ARGUMENT ballotConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainersForBallotConstrainerEnabler
Description

Gets the BallotConstrainers mapped to a BallotConstrainerEnabler.

Parametersosid.id.IdballotConstrainerEnablerId Id of a BallotConstrainerEnabler
Returnosid.voting.rules.BallotConstrainerListlist of ballot constrainers
ErrorsNOT_FOUND ballotConstrainerEnablerId is not found
NULL_ARGUMENT ballotConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.