public interface BallotConstrainerQuery extends OsidConstrainerQuery
This is the query for searching ballot constrainers. Each method match
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 query terms. |
void |
clearPollsTerms()
Clears the polls query terms.
|
void |
clearRuledBallotIdTerms()
Clears the ballot
Id query terms. |
void |
clearRuledBallotTerms()
Clears the ballot query terms.
|
BallotConstrainerQueryRecord |
getBallotConstrainerQueryRecord(Type ballotConstrainerRecordType)
Gets the ballot constrainer query record corresponding to the given
BallotConstrainer record Type. |
PollsQuery |
getPollsQuery()
Gets the query for a polls.
|
BallotQuery |
getRuledBallotQuery()
Gets the query for a ballot.
|
void |
matchAnyRuledBallot(boolean match)
Matches rules mapped to any ballot.
|
void |
matchPollsId(Id pollsId,
boolean match)
Matches rules mapped to the polls.
|
void |
matchRuledBallotId(Id ballotId,
boolean match)
Matches rules mapped to a ballot.
|
boolean |
supportsPollsQuery()
Tests if a
PollsQuery is available. |
boolean |
supportsRuledBallotQuery()
Tests if a
BallotQuery 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 matchRuledBallotId(Id ballotId, boolean match)
ballotId
- the ballot Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- ballotId
is
null
mandatory
- This method must be implemented. void clearRuledBallotIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledBallotQuery()
BallotQuery
is available. true
if a ballot query is available,
false
otherwisemandatory
- This method must be implemented. BallotQuery getRuledBallotQuery()
OR
term.UnimplementedException
-
supportsRuledBallotQuery()
is false
optional
- This method must be implemented if
supportsRuledBallotQuery()
is true.
void matchAnyRuledBallot(boolean match)
match
- true
for rules mapped to any ballot,
false
to match rules mapped to no ballotsmandatory
- This method must be implemented. void clearRuledBallotTerms()
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. BallotConstrainerQueryRecord getBallotConstrainerQueryRecord(Type ballotConstrainerRecordType) throws OperationFailedException
BallotConstrainer
record Type.
Multiple
record retrievals produce a nested OR
term.ballotConstrainerRecordType
- a ballot constrainer record typeNullArgumentException
-
ballotConstrainerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(ballotConstrainerRecordType)
is
false
mandatory
- This method must be implemented.