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

This session provides methods for searching among BallotConstrainerEnabler objects. The search query is constructed using the BallotConstrainerEnablerQuery.

This session defines views that offer differing behaviors for searching.

  • federated polls view: searches include ballot constrainer enablers in polls of which this polls is an ancestor in the polls hierarchy
  • isolated polls view: searches are restricted to ballot constrainer enablers in this polls

Ballot constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the BallotConstrainerEnablerQuery.

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.
MethodcanSearchBallotConstrainerEnablers
Description

Tests if this user can perform BallotConstrainerEnabler lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method 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 broker 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.
MethodgetBallotConstrainerEnablerQuery
Description

Gets a ballot constrainer enabler query.

Returnosid.voting.rules.BallotConstrainerEnablerQuerythe ballot constrainer enabler query
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerEnablersByQuery
Description

Gets a list of BallotConstrainerEnablers matching the given ballot constrainer enabler query.

Parametersosid.voting.rules.BallotConstrainerEnablerQueryballotConstrainerEnablerQuerythe ballot constrainer enabler query
Returnosid.voting.rules.BallotConstrainerEnablerListthe returned BallotConstrainerEnablerList
ErrorsNULL_ARGUMENT ballotConstrainerEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED ballotConstrainerEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.