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

VoteSearch defines the interface for specifying vote search options.

MethodsearchAmongVotes
Description

Execute this search among the given list of votes.

Parametersosid.id.IdListvoteIdsa list of vote Ids
ErrorsNULL_ARGUMENT voteIds is null
CompliancemandatoryThis method must be implemented.
MethodorderVoteResults
Description

Specify an ordering to the search results.

Parametersosid.voting.VoteSearchOrdervoteSearchOrdera vote search order
ErrorsNULL_ARGUMENT voteSearchOrder is null
UNSUPPORTED voteSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetVoteSearchRecord
Description

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

Parametersosid.type.TypevoteSearchRecordTypea vote search record type
Returnosid.voting.records.VoteSearchRecordthe vote search record
ErrorsNULL_ARGUMENT voteSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(voteSearchRecordType) is false
CompliancemandatoryThis method must be implemented.