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

The search interface for governing ballot searches.

MethodsearchAmongBallots
Description

Execute this search among the given list of ballots.

Parametersosid.id.IdListballotIdslist of ballot Ids
ErrorsNULL_ARGUMENT ballotIds is null
CompliancemandatoryThis method must be implemented.
MethodorderBallotResults
Description

Specify an ordering to the search results.

Parametersosid.voting.BallotSearchOrderballotSearchOrderballot search order
ErrorsNULL_ARGUMENT order is null
UNSUPPORTED order is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBallotSearchRecord
Description

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

Parametersosid.type.TypeballotSearchRecordTypea ballot search record type
Returnosid.voting.records.BallotSearchRecordthe ballot search record
ErrorsNULL_ARGUMENT ballotSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(ballotSearchRecordType) is false
CompliancemandatoryThis method must be implemented.