org.osid.voting

Interface BallotQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidGovernatorQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, OsidTemporalQuery, Suppliable

public interface BallotQuery
extends OsidGovernatorQuery, OsidTemporalQuery

This is the query for searching ballots. Each method 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 terms.
void	clearPollsTerms() Clears the polls terms.
void	clearRaceIdTerms() Clears the race Id terms.
void	clearRaceTerms() Clears the race terms.
void	clearRevoteTerms() Clears the revote ballot terms.
BallotQueryRecord	getBallotQueryRecord(Type ballotRecordType) Gets the ballot query record corresponding to the given Ballot record Type.
PollsQuery	getPollsQuery() Gets the query for a polls.
RaceQuery	getRaceQuery() Gets the query for a race.
void	matchAnyRace(boolean match) Matches ballots with any race.
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	matchRevote(boolean match) Matches ballots that allow vote modification.
boolean	supportsPollsQuery() Tests if a PollsQuery is available.
boolean	supportsRaceQuery() Tests if a RaceQuery is available.

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

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchRevote

void matchRevote(boolean match)

Matches ballots that allow vote modification.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRevoteTerms

void clearRevoteTerms()

Clears the revote ballot terms.

Compliance:

mandatory - This method must be implemented.

matchRaceId

void matchRaceId(Id raceId,
               boolean match)

Sets the race Id for this query.

Parameters:

raceId - the race Id

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

Throws:

NullArgumentException - raceId is null

Compliance:

mandatory - This method must be implemented.

clearRaceIdTerms

void clearRaceIdTerms()

Clears the race Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRaceQuery

boolean supportsRaceQuery()

Tests if a RaceQuery is available.

Returns:

true if a race query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRaceQuery

RaceQuery getRaceQuery()

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

Returns:

the race query

Throws:

UnimplementedException - supportsRaceQuery() is false

Compliance:

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

matchAnyRace

void matchAnyRace(boolean match)

Matches ballots with any race.

Parameters:

match - true to match any race, false to match ballots with no races

Compliance:

mandatory - This method must be implemented.

clearRaceTerms

void clearRaceTerms()

Clears the race terms.

Compliance:

mandatory - This method must be implemented.

matchPollsId

void matchPollsId(Id pollsId,
                boolean match)

Sets the polls Id for this query.

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 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 terms.

Compliance:

mandatory - This method must be implemented.

getBallotQueryRecord

BallotQueryRecord getBallotQueryRecord(Type ballotRecordType)
                                       throws OperationFailedException

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

Parameters:

ballotRecordType - a ballot record type

Returns:

the ballot query record

Throws:

NullArgumentException - ballotRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ballotRecordType) is false

Compliance:

mandatory - This method must be implemented.