OSID Logo
OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.PollsSearch
Implementsosid.OsidSearch
Description

The interface for governing polls searches.

MethodsearchAmongPolls
Description

Execute this search among the given list of polls.

Parametersosid.id.IdListpollsIdslist of polls
ErrorsNULL_ARGUMENT pollsIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPollsResults
Description

Specify an ordering to the search results.

Parametersosid.voting.PollsSearchOrderpollsSearchOrderpolls search order
ErrorsNULL_ARGUMENT pollsSearchOrder is null
UNSUPPORTED pollsSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPollsSearchRecord
Description

Gets the polls search record corresponding to the given polls search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypepollsSearchRecordTypea polls search record type
Returnosid.voting.records.PollsSearchRecordthe polls search record
ErrorsNULL_ARGUMENT pollsSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(pollsSearchRecordType) is false
CompliancemandatoryThis method must be implemented.