org.osid.voting

Interface RaceSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidGovernatorSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, OsidSubjugateableSearchOrder, Suppliable

public interface RaceSearchOrder
extends OsidGovernatorSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
BallotSearchOrder	getBallotSearchOrder() Gets the ballot search order.
RaceSearchOrderRecord	getRaceSearchOrderRecord(Type raceRecordType) Gets the polls search order record corresponding to the given race record Type.
void	orderByBallot(SearchOrderStyle style) Orders the results by the ballot.
boolean	supportsBallotSearchOrder() Tests if a ballot search order is available.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

orderByBallot

void orderByBallot(SearchOrderStyle style)

Orders the results by the ballot.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsBallotSearchOrder

boolean supportsBallotSearchOrder()

Tests if a ballot search order is available.

Returns:

true if a ballot search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBallotSearchOrder

BallotSearchOrder getBallotSearchOrder()

Gets the ballot search order.

Returns:

the ballot search order

Throws:

IllegalStateException - supportsBallotSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

getRaceSearchOrderRecord

RaceSearchOrderRecord getRaceSearchOrderRecord(Type raceRecordType)
                                               throws OperationFailedException

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

Parameters:

raceRecordType - a race record type

Returns:

the race search order record

Throws:

NullArgumentException - raceRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceRecordType) is false

Compliance:

mandatory - This method must be implemented.