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

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

Polls may have a polls query record indicated by their respective record types. The polls query record is accessed via the PollsQuery.

MethodcanSearchPolls
Description

Tests if this user can perform Polls 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.
MethodgetPollsQuery
Description

Gets a polls query.

Returnosid.voting.PollsQuerythe polls query
CompliancemandatoryThis method must be implemented.
MethodgetPollsByQuery
Description

Gets a list of Polls matching the given query.

Parametersosid.voting.PollsQuerypollsQuerythe polls query
Returnosid.voting.PollsListthe returned PollsList
ErrorsNULL_ARGUMENT pollsQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDa pollsQuery is not of this service
CompliancemandatoryThis method must be implemented.