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

This session manages queries and sequencing to create "smart" dynamic polls. a RaceConstrainerEnablerQuery can be retrieved from this session and mapped to this Polls to create a virtual collection of race constrainer enablers. The race constrainer enablers may be sequenced using the RaceConstrainerEnablerSearchOrder from this session.

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

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

Gets a race constrainer enabler query.

Returnosid.voting.rules.RaceConstrainerEnablerQuerythe race constrainer enabler query
CompliancemandatoryThis method must be implemented.
MethodgetRaceConstrainerEnablerSearchOrder
Description

Gets a race constrainer enabler search order.

Returnosid.voting.rules.RaceConstrainerEnablerSearchOrderthe race constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyRaceConstrainerEnablerQuery
Description

Applies a race constrainer enabler query to this polls.

Parametersosid.voting.rules.RaceConstrainerEnablerQueryraceConstrainerEnablerQuerythe race constrainer enabler query
ErrorsNULL_ARGUMENT raceConstrainerEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED raceConstrainerEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectRaceConstrainerEnablerQuery
Description

Gets a race constrainer enabler query inspector for this polls.

Returnosid.voting.rules.RaceConstrainerEnablerQueryInspectorthe race constrainer enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyRaceConstrainerEnablerSequencing
Description

Applies a race constrainer enabler search order to this polls.

Parametersosid.voting.rules.RaceConstrainerEnablerSearchOrderraceConstrainerEnablerSearchOrderthe race constrainer enabler search order
ErrorsNULL_ARGUMENT raceConstrainerEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED raceConstrainerEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRaceConstrainerEnablerQueryFromInspector
Description

Gets a race constrainer enabler query from an inspector.

Parametersosid.voting.rules.RaceConstrainerEnablerQueryInspectorraceConstrainerEnablerQueryInspectora race constrainer enabler query inspector
Returnosid.voting.rules.RaceConstrainerEnablerQuerythe race constrainer enabler query
ErrorsNULL_ARGUMENT raceConstrainerEnablerQueryInspector is null
UNSUPPORTED raceConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.