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

This session manages queries and sequencing to create "smart" dynamic polls. a RaceProcessorQuery can be retrieved from this session and mapped to this Polls to create a virtual collection of race processors. The race processor may be sequenced using the RaceProcessorSearchOrder from this session.

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

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

Gets a race processor query.

Returnosid.voting.rules.RaceProcessorQuerythe race processor query
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorSearchOrder
Description

Gets a race processor search order.

Returnosid.voting.rules.RaceProcessorSearchOrderthe race processor search order
CompliancemandatoryThis method must be implemented.
MethodapplyRaceProcessorQuery
Description

Applies a race processor query to this polls.

Parametersosid.voting.rules.RaceProcessorQueryraceProcessorQuerythe race processor query
ErrorsNULL_ARGUMENT raceProcessorQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED raceProcessorQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectRaceProcessorQuery
Description

Gets a race processor query inspector for this polls.

Returnosid.voting.rules.RaceProcessorQueryInspectorthe race processor query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyRaceProcessorSequencing
Description

Applies a race processor search order to this polls.

Parametersosid.voting.rules.RaceProcessorSearchOrderraceProcessorSearchOrderthe race processor search order
ErrorsNULL_ARGUMENT raceProcessorSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED raceProcessorSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorQueryFromInspector
Description

Gets a race processor query from an inspector.

Parametersosid.voting.rules.RaceProcessorQueryInspectorraceProcessorQueryInspectora race processor query inspector
Returnosid.voting.rules.RaceProcessorQuerythe race processor query
ErrorsNULL_ARGUMENT raceProcessorQueryInspector is null
UNSUPPORTED raceProcessorQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.