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.
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. |
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
void matchMaximumWinners(long low, long high, boolean match)
low
- start of rangehigh
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void matchAnyMaximumWinners(boolean match)
match
- true
to match rules with a maximum winner
value, false
to match rules with no maximum
winner valuemandatory
- This method must be implemented. void clearMaximumWinnersTerms()
mandatory
- This method must be implemented. void matchMinimumPercentageToWin(long low, long high, boolean match)
low
- start of rangehigh
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void matchAnyMinimumPercentageToWin(boolean match)
match
- true
to match rules with a minimum value,
false
to match rules with no minimum valuemandatory
- This method must be implemented. void clearMinimumPercentageToWinTerms()
mandatory
- This method must be implemented. void matchMinimumVotesToWin(long low, long high, boolean match)
low
- start of rangehigh
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void matchAnyMinimumVotesToWin(boolean match)
match
- true
to match rules with a minimum value,
false
to match rules with no minimum valuemandatory
- This method must be implemented. void clearMinimumVotesToWinTerms()
mandatory
- This method must be implemented. void matchRuledRaceId(Id raceId, boolean match)
raceId
- the race Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- raceId
is
null
mandatory
- This method must be implemented. void clearRuledRaceIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledRaceQuery()
RaceQuery
is available. true
if a race query is available, false
otherwisemandatory
- This method must be implemented. RaceQuery getRuledRaceQuery()
OR
term.UnimplementedException
-
supportsRuledRaceQuery()
is false
optional
- This method must be implemented if
supportsRuledRaceQuery()
is true.
void matchAnyRuledRace(boolean match)
match
- true
for rules mapped to any race,
false
to match rules mapped to no racemandatory
- This method must be implemented. void clearRuledRaceTerms()
mandatory
- This method must be implemented. void matchPollsId(Id pollsId, boolean match)
pollsId
- the polls Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- pollsId
is
null
mandatory
- This method must be implemented. void clearPollsIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsPollsQuery()
PollsQuery
is available. true
if a polls query is available,
false
otherwisemandatory
- This method must be implemented. PollsQuery getPollsQuery()
OR
term.UnimplementedException
- supportsPollsQuery()
is false
optional
- This method must be implemented if
supportsPollsQuery()
is true.
void clearPollsTerms()
mandatory
- This method must be implemented. RaceProcessorQueryRecord getRaceProcessorQueryRecord(Type raceProcessorRecordType) throws OperationFailedException
RaceProcessor
record Type.
Multiple record
retrievals produce a nested OR
term.raceProcessorRecordType
- a race processor record typeNullArgumentException
- raceProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(raceProcessorRecordType)
is false
mandatory
- This method must be implemented.