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

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

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.
MethodcanAssignBallotConstrainerEnablers
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 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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignBallotConstrainerEnablerToBallotConstrainer
Description

Adds an existing BallotConstrainerEnabler to a BallotConstrainer.

Parametersosid.id.IdballotConstrainerEnablerIdthe Id of the BallotConstrainerEnabler
osid.id.IdballotConstrainerIdthe Id of the BallotConstrainer
ErrorsALREADY_EXISTS ballotConstrainerEnablerId is already applied to ballotConstrainerId
NOT_FOUND ballotConstrainerEnablerId or ballotConstrainerId not found
NULL_ARGUMENT ballotConstrainerEnablerId or ballotConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignBallotConstrainerEnablerFromBallotConstrainer
Description

Removes a BallotConstrainerEnabler from a BallotConstrainer.

Parametersosid.id.IdballotConstrainerEnablerIdthe Id of the BallotConstrainerEnabler
osid.id.IdballotConstrainerIdthe Id of the BallotConstrainer
ErrorsNOT_FOUND ballotConstrainerEnablerId or ballotConstrainerId not found or ballotConstrainerEnablerId not applied to ballotConstrainerId
NULL_ARGUMENT ballotConstrainerEnablerId or ballotConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceBallotConstrainerEnablers
Description

Tests if this user can order BallotConstrainerEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if BallotConstrainerEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveBallotConstrainerEnablerAhead
Description

Reorders ballot constrainer enablers for a ballot constrainer by moving the specified ballot constrainer enabler in front of a reference ballot constrainer enabler.

Parametersosid.id.IdballotConstrainerEnablerIdthe Id of a BallotConstrainerEnabler
osid.id.IdballotConstrainerIdthe Id of a BallotConstrainer
osid.id.IdreferenceIdthe reference ballot constrainer enabler Id
ErrorsNOT_FOUND ballotConstrainerEnablerId, ballotConstrainerId, or referenceId not found or, ballotConstrainerId or referenceId not related to ballotConstrainerId
NULL_ARGUMENT ballotConstrainerEnablerId, ballotConstrainerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveBallotConstrainerEnablerBehind
Description

Reorders ballot constrainer enablers for a ballot constrainer by moving the specified ballot constrainer enabler behind a reference ballot constrainer enabler.

Parametersosid.id.IdballotConstrainerEnablerIdthe Id of a BallotConstrainerEnabler
osid.id.IdballotConstrainerIdthe Id of a BallotConstrainer
osid.id.IdreferenceIdthe reference ballot constrainer enabler Id
ErrorsNOT_FOUND ballotConstrainerEnablerId, ballotConstrainerId, or referenceId not found or, ballotConstrainerId or referenceId not related to ballotConstrainerId
NULL_ARGUMENT ballotConstrainerEnablerId, ballotConstrainerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderBallotConstrainerEnablers
Description

Reorders a set of ballot constrainer enablers for a ballot constrainer.

Parametersosid.id.Id[]ballotConstrainerEnablerIdsthe Ids for a set of BallotConstrainerEnablers
osid.id.IdballotConstrainerIdthe Id of a BallotConstrainer
ErrorsNOT_FOUND ballotConstrainerId not found or, a ballotConstrainerEnablerId not related to ballotConstrainerId
NULL_ARGUMENT ballotConstrainerEnablerIds or ballotConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.