OSID Logo
OSID Specifications
voting package
Version 3.1.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.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodsupportsBallotSearchOrder
Description

Tests if a ballot search order is available.

Returnboolean true if a ballot search order is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetBallotSearchOrder
Description

Gets the ballot search order.

Returnosid.voting.BallotSearchOrder the ballot search order
ErrorsILLEGAL_STATE supportsBallotSearchOrder() is false
Compliancemandatory This 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.TyperaceRecordType a race record type
Returnosid.voting.records.RaceSearchOrderRecord the race search order record
ErrorsNULL_ARGUMENT raceRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(raceRecordType) is false
Compliancemandatory This method must be implemented.