org.osid.voting.rules

Interface BallotConstrainerQuery

All Superinterfaces:

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

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.

Method Summary

Methods

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.

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

matchRuledBallotId

void matchRuledBallotId(Id ballotId,
                      boolean match)

Matches rules mapped to a ballot.

Parameters:

ballotId - the ballot Id

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

Throws:

NullArgumentException - ballotId is null

Compliance:

mandatory - This method must be implemented.

clearRuledBallotIdTerms

void clearRuledBallotIdTerms()

Clears the ballot Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledBallotQuery

boolean supportsRuledBallotQuery()

Tests if a BallotQuery is available.

Returns:

true if a ballot query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledBallotQuery

BallotQuery getRuledBallotQuery()

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

Returns:

the ballot query

Throws:

UnimplementedException - supportsRuledBallotQuery() is false

Compliance:

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

matchAnyRuledBallot

void matchAnyRuledBallot(boolean match)

Matches rules mapped to any ballot.

Parameters:

match - true for rules mapped to any ballot, false to match rules mapped to no ballots

Compliance:

mandatory - This method must be implemented.

clearRuledBallotTerms

void clearRuledBallotTerms()

Clears the ballot 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.

getBallotConstrainerQueryRecord

BallotConstrainerQueryRecord getBallotConstrainerQueryRecord(Type ballotConstrainerRecordType)
                                                             throws OperationFailedException

Gets the ballot constrainer query record corresponding to the given BallotConstrainer record Type. Multiple record retrievals produce a nested OR term.

Parameters:

ballotConstrainerRecordType - a ballot constrainer record type

Returns:

the ballot constrainer query record

Throws:

NullArgumentException - ballotConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ballotConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.