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

This session provides methods for searching Vote objects. The search query is constructed using the VoteQuery. The vote record Type also specifies the record for the vote query.

This session defines views that offer differing behaviors for searching.

  • federated polls view: searches include votes in polls of which these polls is a ancestor in the polls hierarchy
  • isolated polls view: searches are restricted to votes in these polls only

Votes may have a query record indicated by their respective record types. The query record is accessed via the 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
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchVotes
Description

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

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedPollsView
Description

Federates the view for methods in this session. A federated view will include votes in polls which are children of this polls in the polls hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedPollsView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this polls only.

CompliancemandatoryThis method is must be implemented.
MethodgetVoteQuery
Description

Gets a vote query.

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

Gets a list of Vote matching the given vote query.

Parametersosid.voting.VoteQueryvoteQuerythe vote query
Returnosid.voting.VoteListthe returned VoteList
ErrorsNULL_ARGUMENT voteQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED voteQuery is not of this service
CompliancemandatoryThis method must be implemented.