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

This session provides methods for searching among Candidate objects. The search query is constructed using the CandidateQuery.

This session defines views that offer differing behaviors for searching.

  • federated polls view: searches include candidates in polls of which this polls is a ancestor in the polls hierarchy
  • isolated polls view: searches are restricted to candidates in this polls

Candidates may have a candidate query record indicated by their respective record types. The candidate query record is accessed via the 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.
MethodcanSearchCandidates
Description

Tests if this user can perform Candidate 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 candidates 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 lookups to this polls only.

CompliancemandatoryThis method is must be implemented.
MethodgetCandidateQuery
Description

Gets a candidate query. The returned query will not have an extension query.

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

Gets a list of Candidates matching the given candidate query.

Parametersosid.voting.CandidateQuerycandidateQuerythe candidate query
Returnosid.voting.CandidateListthe returned CandidateList
ErrorsNULL_ARGUMENT candidateQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED candidateQuery is not of this service
CompliancemandatoryThis method must be implemented.