org.osid.voting.rules

Interface RaceProcessorQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidProcessorQuery, OsidQuery, OsidRuleQuery, Suppliable

public interface RaceProcessorQuery
extends OsidProcessorQuery

This is the query for searching race processors. Each method match specifies a AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearMaximumWinnersTerms() Clears the maximum winners terms.
void	clearMinimumPercentageToWinTerms() Clears the minimum percentage to win terms.
void	clearMinimumVotesToWinTerms() Clears the minimum votes to win terms.
void	clearPollsIdTerms() Clears the polls Id query terms.
void	clearPollsTerms() Clears the polls query terms.
void	clearRuledRaceIdTerms() Clears the race Id query terms.
void	clearRuledRaceTerms() Clears the race query terms.
PollsQuery	getPollsQuery() Gets the query for a polls.
RaceProcessorQueryRecord	getRaceProcessorQueryRecord(Type raceProcessorRecordType) Gets the race processor query record corresponding to the given RaceProcessor record Type.
RaceQuery	getRuledRaceQuery() Gets the query for a race.
void	matchAnyMaximumWinners(boolean match) Matches rules with any maximum winner value.
void	matchAnyMinimumPercentageToWin(boolean match) Matches rules with any minimum percentage to win value.
void	matchAnyMinimumVotesToWin(boolean match) Matches rules with any minimum votes to win value.
void	matchAnyRuledRace(boolean match) Matches any rule mapped to any race.
void	matchMaximumWinners(long low, long high, boolean match) Matches rules with a maximum winners value between the given range inclusive.
void	matchMinimumPercentageToWin(long low, long high, boolean match) Matches rules with a minimum percentage to win value between the given range inclusive.
void	matchMinimumVotesToWin(long low, long high, boolean match) Matches rules with a minimum votes to win value between the given range inclusive.
void	matchPollsId(Id pollsId, boolean match) Matches rules mapped to the polls.
void	matchRuledRaceId(Id raceId, boolean match) Matches rules mapped to the race.
boolean	supportsPollsQuery() Tests if a PollsQuery is available.
boolean	supportsRuledRaceQuery() Tests if a RaceQuery is available.

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Method Detail

matchMaximumWinners

void matchMaximumWinners(long low,
                       long high,
                       boolean match)

Matches rules with a maximum winners value between the given range inclusive.

Parameters:

low - start of range

high - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

matchAnyMaximumWinners

void matchAnyMaximumWinners(boolean match)

Matches rules with any maximum winner value.

Parameters:

match - true to match rules with a maximum winner value, false to match rules with no maximum winner value

Compliance:

mandatory - This method must be implemented.

clearMaximumWinnersTerms

void clearMaximumWinnersTerms()

Clears the maximum winners terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumPercentageToWin

void matchMinimumPercentageToWin(long low,
                               long high,
                               boolean match)

Matches rules with a minimum percentage to win value between the given range inclusive.

Parameters:

low - start of range

high - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

matchAnyMinimumPercentageToWin

void matchAnyMinimumPercentageToWin(boolean match)

Matches rules with any minimum percentage to win value.

Parameters:

match - true to match rules with a minimum value, false to match rules with no minimum value

Compliance:

mandatory - This method must be implemented.

clearMinimumPercentageToWinTerms

void clearMinimumPercentageToWinTerms()

Clears the minimum percentage to win terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumVotesToWin

void matchMinimumVotesToWin(long low,
                          long high,
                          boolean match)

Matches rules with a minimum votes to win value between the given range inclusive.

Parameters:

low - start of range

high - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

matchAnyMinimumVotesToWin

void matchAnyMinimumVotesToWin(boolean match)

Matches rules with any minimum votes to win value.

Parameters:

match - true to match rules with a minimum value, false to match rules with no minimum value

Compliance:

mandatory - This method must be implemented.

clearMinimumVotesToWinTerms

void clearMinimumVotesToWinTerms()

Clears the minimum votes to win terms.

Compliance:

mandatory - This method must be implemented.

matchRuledRaceId

void matchRuledRaceId(Id raceId,
                    boolean match)

Matches rules mapped to the race.

Parameters:

raceId - the race Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - raceId is null

Compliance:

mandatory - This method must be implemented.

clearRuledRaceIdTerms

void clearRuledRaceIdTerms()

Clears the race Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledRaceQuery

boolean supportsRuledRaceQuery()

Tests if a RaceQuery is available.

Returns:

true if a race query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledRaceQuery

RaceQuery getRuledRaceQuery()

Gets the query for a race. Multiple retrievals produce a nested OR term.

Returns:

the race query

Throws:

UnimplementedException - supportsRuledRaceQuery() is false

Compliance:

optional - This method must be implemented if supportsRuledRaceQuery() is true.

matchAnyRuledRace

void matchAnyRuledRace(boolean match)

Matches any rule mapped to any race.

Parameters:

match - true for rules mapped to any race, false to match rules mapped to no race

Compliance:

mandatory - This method must be implemented.

clearRuledRaceTerms

void clearRuledRaceTerms()

Clears the race query terms.

Compliance:

mandatory - This method must be implemented.

matchPollsId

void matchPollsId(Id pollsId,
                boolean match)

Matches rules mapped to the polls.

Parameters:

pollsId - the polls Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - pollsId is null

Compliance:

mandatory - This method must be implemented.

clearPollsIdTerms

void clearPollsIdTerms()

Clears the polls Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsPollsQuery

boolean supportsPollsQuery()

Tests if a PollsQuery is available.

Returns:

true if a polls query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPollsQuery

PollsQuery getPollsQuery()

Gets the query for a polls. Multiple retrievals produce a nested OR term.

Returns:

the polls query

Throws:

UnimplementedException - supportsPollsQuery() is false

Compliance:

optional - This method must be implemented if supportsPollsQuery() is true.

clearPollsTerms

void clearPollsTerms()

Clears the polls query terms.

Compliance:

mandatory - This method must be implemented.

getRaceProcessorQueryRecord

RaceProcessorQueryRecord getRaceProcessorQueryRecord(Type raceProcessorRecordType)
                                                     throws OperationFailedException

Gets the race processor query record corresponding to the given RaceProcessor record Type. Multiple record retrievals produce a nested OR term.

Parameters:

raceProcessorRecordType - a race processor record type

Returns:

the race processor query record

Throws:

NullArgumentException - raceProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.