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

This session manages queries and sequencing to create "smart" dynamic catalogs. A VoteQuery can be retrieved from this session and mapped to this Polls to create a virtual collection of Votes. The votes may be sequenced using the VoteSearchOrder from this session.

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

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

Gets a vote query.

Returnosid.voting.VoteQuerythe vote query
CompliancemandatoryThis method must be implemented.
MethodgetVoteSearchOrder
Description

Gets a vote search order.

Returnosid.voting.VoteSearchOrderthe vote search order
CompliancemandatoryThis method must be implemented.
MethodapplyVoteQuery
Description

Applies a vote query to this polls.

Parametersosid.voting.VoteQueryvoteQuerythe vote query
ErrorsNULL_ARGUMENT voteQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED voteQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectVoteQuery
Description

Gets a vote query inspector for this polls.

Returnosid.voting.VoteQueryInspectorthe vote query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyVoteSequencing
Description

Applies a vote search order to this polls.

Parametersosid.voting.VoteSearchOrdervoteSearchOrderthe vote search order
ErrorsNULL_ARGUMENT voteSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED voteSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetVoteQueryFromInspector
Description

Gets a vote query from an inspector.

Parametersosid.voting.VoteQueryInspectorvoteQueryInspectora vote query inspector
Returnosid.voting.VoteQuerythe vote query
ErrorsNULL_ARGUMENT voteQueryInspector is null
UNSUPPORTED voteQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.