OSID Logo
OSID Specifications
voting package
Version 3.0.0
Interfaceosid.voting.RaceSearchOrder
Implementsosid.OsidGovernatorSearchOrder
osid.OsidSubjugateableSearchOrder
Used Byosid.voting.CandidateSearchOrder
osid.voting.RaceSearchSession
osid.voting.RaceSmartPollsSession
Description

An interface for specifying the ordering of search results.

MethodorderByBallot
Description

Orders the results by the ballot.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENTstyle is null
CompliancemandatoryThis method must be implemented.
MethodsupportsBallotSearchOrder
Description

Tests if a ballot search order is available.

Returnbooleantrue if a ballot search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBallotSearchOrder
Description

Gets the ballot search order.

Returnosid.voting.BallotSearchOrderthe ballot search order
ErrorsILLEGAL_STATEsupportsBallotSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodgetRaceSearchOrderRecord
Description

Gets the polls search order record corresponding to the given race record Type . Multiple retrievals return the same underlying object.

Parametersosid.type.TyperaceRecordTypea race record type
Returnosid.voting.records.RaceSearchOrderRecordthe race search order record
ErrorsNULL_ARGUMENTraceRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(raceRecordType) is false
CompliancemandatoryThis method must be implemented.