org.osid.voting.rules

Interface RaceProcessorSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidProcessorSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable

public interface RaceProcessorSearchOrder
extends OsidProcessorSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
RaceProcessorSearchOrderRecord	getRaceProcessorSearchOrderRecord(Type raceProcessorRecordType) Gets the race processor search order record corresponding to the given race processor record Type.
void	orderByMaximumWinners(SearchOrderStyle style) Specified a preference for ordering the maximum winners value.
void	orderByMinimumPercentageToWin(SearchOrderStyle style) Specified a preference for ordering the minimum percentage to win value.
void	orderByMinimumVotesToWin(SearchOrderStyle style) Specified a preference for ordering the minimum votes to win value.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

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

Method Detail

orderByMaximumWinners

void orderByMaximumWinners(SearchOrderStyle style)

Specified a preference for ordering the maximum winners value.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByMinimumPercentageToWin

void orderByMinimumPercentageToWin(SearchOrderStyle style)

Specified a preference for ordering the minimum percentage to win value.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByMinimumVotesToWin

void orderByMinimumVotesToWin(SearchOrderStyle style)

Specified a preference for ordering the minimum votes to win value.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getRaceProcessorSearchOrderRecord

RaceProcessorSearchOrderRecord getRaceProcessorSearchOrderRecord(Type raceProcessorRecordType)
                                                                 throws OperationFailedException

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

Parameters:

raceProcessorRecordType - a race processor record type

Returns:

the race processor search order record

Throws:

NullArgumentException - raceProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.