public interface CandidateQuery extends OsidRelationshipQuery
This is the query for searching candidates. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearPollsIdTerms()
Clears the polls
Id terms. |
void |
clearPollsTerms()
Clears the polls terms.
|
void |
clearRaceIdTerms()
Clears the race
Id terms. |
void |
clearRaceTerms()
Clears the race terms.
|
void |
clearResourceIdTerms()
Clears the resource
Id terms. |
void |
clearResourceTerms()
Clears the resource terms.
|
void |
clearVoteIdTerms()
Clears the vote
Id terms. |
void |
clearVoteTerms()
Clears the vote terms.
|
CandidateQueryRecord |
getCandidateQueryRecord(Type candidateRecordType)
Gets the candidate query record corresponding to the given
Candidate record Type. |
PollsQuery |
getPollsQuery()
Gets the query for a polls.
|
RaceQuery |
getRaceQuery()
Gets the query for a race.
|
ResourceQuery |
getResourceQuery()
Gets the query for a resource.
|
VoteQuery |
getVoteQuery()
Gets the query for a vote.
|
void |
matchAnyVote(boolean match)
Matches candidates with any vote.
|
void |
matchPollsId(Id pollsId,
boolean match)
Sets the polls
Id for this query. |
void |
matchRaceId(Id raceId,
boolean match)
Sets the race
Id for this query. |
void |
matchResourceId(Id resourceId,
boolean match)
Sets the resource
Id for this query. |
void |
matchVoteId(Id voteId,
boolean match)
Sets the vote
Id for this query. |
boolean |
supportsPollsQuery()
Tests if a
PollsQuery is available. |
boolean |
supportsRaceQuery()
Tests if a
RaceQuery is available for querying
candidates. |
boolean |
supportsResourceQuery()
Tests if a
ResourceQuery is available for querying
candidates. |
boolean |
supportsVoteQuery()
Tests if a
VoteQuery is available. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRaceId(Id raceId, boolean match)
Id
for this query.raceId
- a race Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- raceId
is
null
mandatory
- This method must be implemented. void clearRaceIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsRaceQuery()
RaceQuery
is available for querying
candidates. true
if a race query is available, false
otherwisemandatory
- This method must be implemented. RaceQuery getRaceQuery()
OR
term.UnimplementedException
- supportsRaceQuery()
is false
optional
- This method must be implemented if
supportsRaceQuery()
is true.
void clearRaceTerms()
mandatory
- This method must be implemented. void matchResourceId(Id resourceId, boolean match)
Id
for this query.resourceId
- a resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearResourceIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsResourceQuery()
ResourceQuery
is available for querying
candidates. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getResourceQuery()
OR
term.UnimplementedException
- supportsResourceQuery()
is false
optional
- This method must be implemented if
supportsResourceQuery()
is true.
void clearResourceTerms()
mandatory
- This method must be implemented. void matchVoteId(Id voteId, boolean match)
Id
for this query.voteId
- the vote Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- voteId
is
null
mandatory
- This method must be implemented. void clearVoteIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsVoteQuery()
VoteQuery
is available. true
if a vote query is available, false
otherwisemandatory
- This method must be implemented. VoteQuery getVoteQuery()
OR
term.UnimplementedException
- supportsVoteQuery()
is false
optional
- This method must be implemented if
supportsVoteQuery()
is true.
void matchAnyVote(boolean match)
match
- true
to match any vote, false
to match candidates with no votesmandatory
- This method must be implemented. void clearVoteTerms()
mandatory
- This method must be implemented. void matchPollsId(Id pollsId, boolean match)
Id
for this query.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
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. CandidateQueryRecord getCandidateQueryRecord(Type candidateRecordType) throws OperationFailedException
Candidate
record Type.
Multiple retrievals
produce a nested OR
term.candidateRecordType
- a candidate record typeNullArgumentException
- candidateRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(candidateRecordType)
is false
mandatory
- This method must be implemented.