OSID Logo
OSID Specifications
voting package
Version 3.0.0
Interfaceosid.voting.PollsSearch
Implementsosid.OsidSearch
Used Byosid.voting.PollsSearchSession
Description

The interface for governing polls searches.

MethodsearchAmongPolls
Description

Execute this search among the given list of polls.

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

Specify an ordering to the search results.

Parametersosid.voting.PollsSearchOrderpollsSearchOrderpolls search order
ErrorsNULL_ARGUMENTpollsSearchOrder is null
UNSUPPORTEDpollsSearchOrder 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_ARGUMENTpollsSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(pollsSearchRecordType) is false
CompliancemandatoryThis method must be implemented.