public interface RaceQuery extends OsidGovernatorQuery, OsidSubjugateableQuery
This is the query for searching races. Each method specifies an
AND
term while multiple invocations of the same method produce a
nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearBallotIdTerms()
Clears the ballot
Id terms. |
void |
clearBallotTerms()
Clears the ballot terms.
|
void |
clearCandidateIdTerms()
Clears the candidate
Id terms. |
void |
clearCandidateTerms()
Clears the candidate terms.
|
void |
clearPollsIdTerms()
Clears the polls
Id terms. |
void |
clearPollsTerms()
Clears the polls terms.
|
BallotQuery |
getBallotQuery()
Gets the query for a ballot.
|
CandidateQuery |
getCandidateQuery()
Gets the query for a candidate.
|
PollsQuery |
getPollsQuery()
Gets the query for a polls.
|
RaceQueryRecord |
getRaceQueryRecord(Type raceRecordType)
Gets the race query record corresponding to the given
Race
record Type. |
void |
matchAnyCandidate(boolean match)
Matches polls with any candidate.
|
void |
matchBallotId(Id ballotId,
boolean match)
Sets the ballot
Id for this query. |
void |
matchCandidateId(Id candidateId,
boolean match)
Sets the candidate
Id for this query. |
void |
matchPollsId(Id pollsid,
boolean match)
Sets the polls
Id for this query. |
boolean |
supportsBallotQuery()
Tests if a
BallotQuery is available. |
boolean |
supportsCandidateQuery()
Tests if a
CandidateQuery is available. |
boolean |
supportsPollsQuery()
Tests if a
PollsQuery is available. |
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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchBallotId(Id ballotId, boolean match)
Id
for this query.ballotId
- a ballot Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- ballotId
is
null
mandatory
- This method must be implemented. void clearBallotIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsBallotQuery()
BallotQuery
is available. true
if a ballot query is available,
false
otherwisemandatory
- This method must be implemented. BallotQuery getBallotQuery()
OR
term.UnimplementedException
- supportsBallotQuery()
is false
optional
- This method must be implemented if
supportsBallotQuery()
is true.
void clearBallotTerms()
mandatory
- This method must be implemented. void matchCandidateId(Id candidateId, boolean match)
Id
for this query.candidateId
- a candidate Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- candidateId
is
null
mandatory
- This method must be implemented. void clearCandidateIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCandidateQuery()
CandidateQuery
is available. true
if a candidate query is available,
false
otherwisemandatory
- This method must be implemented. CandidateQuery getCandidateQuery()
OR
term.UnimplementedException
-
supportsCandidateQuery()
is false
optional
- This method must be implemented if
supportsCandidateQuery()
is true.
void matchAnyCandidate(boolean match)
match
- true
to match polls with any candidate,
false
to match polls with no candidatesmandatory
- This method must be implemented. void clearCandidateTerms()
mandatory
- This method must be implemented. void matchPollsId(Id pollsid, boolean match)
Id
for this query.pollsid
- a 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
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. RaceQueryRecord getRaceQueryRecord(Type raceRecordType) throws OperationFailedException
Race
record Type.
Multiple retrievals produce a
nested OR
term.raceRecordType
- a race record typeNullArgumentException
- raceRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(raceRecordType)
is false
mandatory
- This method must be implemented.