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

This session manages queries and sequencing to create "smart" dynamic polls. A BallotConstrainerQuery can be retrieved from this session and mapped to this Polls to create a virtual collection of ballot constrainers. The ballot constrainer may be sequenced using the BallotConstrainerSearchOrder from this session.

This Polls has a default query that matches any ballot constrainer and a default search order that specifies no sequencing. The queries may be examined using a BallotConstrainerQueryInspector. The query may be modified by converting the inspector back to a BallotConstrainerQuery.

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

Tests if this user can manage smart polls. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart polls management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerQuery
Description

Gets a ballot constrainer query.

Returnosid.voting.rules.BallotConstrainerQuerythe ballot constrainer query
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerSearchOrder
Description

Gets a ballot constrainer search order.

Returnosid.voting.rules.BallotConstrainerSearchOrderthe ballot constrainer search order
CompliancemandatoryThis method must be implemented.
MethodapplyBallotConstrainerQuery
Description

Applies a ballot constrainer query to this polls.

Parametersosid.voting.rules.BallotConstrainerQueryballotConstrainerQuerythe ballot constrainer query
ErrorsNULL_ARGUMENT ballotConstrainerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED ballotConstrainerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectBallotConstrainerQuery
Description

Gets a ballot constrainer query inspector for this polls.

Returnosid.voting.rules.BallotConstrainerQueryInspectorthe ballot constrainer query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyBallotConstrainerSequencing
Description

Applies a ballot constrainer search order to this polls.

Parametersosid.voting.rules.BallotConstrainerSearchOrderballotConstrainerSearchOrderthe ballot constrainer search order
ErrorsNULL_ARGUMENT ballotConstrainerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED ballotConstrainerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerQueryFromInspector
Description

Gets a ballot constrainer query from an inspector.

Parametersosid.voting.rules.BallotConstrainerQueryInspectorballotConstrainerQueryInspectora ballot constrainer query inspector
Returnosid.voting.rules.BallotConstrainerQuerythe ballot constrainer query
ErrorsNULL_ARGUMENT ballotConstrainerQueryInspector is null
UNSUPPORTED ballotConstrainerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.