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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CandidateQuery can be retrieved from this session and mapped to this Polls to create a virtual collection of Candidates. The candidates may be sequenced using the CandidateSearchOrder from this session.

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

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 associated with this session
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.
MethodgetCandidateQuery
Description

Gets a candidate query.

Returnosid.voting.CandidateQuerythe candidate query
CompliancemandatoryThis method must be implemented.
MethodgetCandidateSearchOrder
Description

Gets a candidate search order.

Returnosid.voting.CandidateSearchOrderthe candidate search order
CompliancemandatoryThis method must be implemented.
MethodapplyCandidateQuery
Description

Applies a candidate query to this polls.

Parametersosid.voting.CandidateQuerycandidateQuerythe candidate query
ErrorsNULL_ARGUMENT candidateQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED candidateQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectCandidateQuery
Description

Gets a candidate query inspector for this polls.

Returnosid.voting.CandidateQueryInspectorthe candidate query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyCandidateSequencing
Description

Applies a candidate search order to this polls.

Parametersosid.voting.CandidateSearchOrdercandidateSearchOrderthe candidate search order
ErrorsNULL_ARGUMENT candidateSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED candidateSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCandidateQueryFromInspector
Description

Gets a candidate query from an inspector.

Parametersosid.voting.CandidateQueryInspectorcandidateQueryInspectora candidate query inspector
Returnosid.voting.CandidateQuerythe candidate query
ErrorsNULL_ARGUMENT candidateQueryInspector is null
UNSUPPORTED candidateQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.