org.osid.voting.rules

Interface RaceConstrainerQuery

All Superinterfaces:

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

public interface RaceConstrainerQuery
extends OsidConstrainerQuery

This is the query for searching race constrainers. Each method match specifies a 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	clearRuledRaceIdTerms() Clears the race Id query terms.
void	clearRuledRaceTerms() Clears the race query terms.
PollsQuery	getPollsQuery() Gets the query for a polls.
RaceConstrainerQueryRecord	getRaceConstrainerQueryRecord(Type raceConstrainerRecordType) Gets the race constrainer query record corresponding to the given RaceConstrainer record Type.
RaceQuery	getRuledRaceQuery() Gets the query for a race.
void	matchAnyRuledRace(boolean match) Matches constrainers mapped to any race.
void	matchPollsId(Id pollsId, boolean match) Matches constrainers mapped to the polls.
void	matchRuledRaceId(Id raceId, boolean match) Matches mapped to a race.
boolean	supportsPollsQuery() Tests if a PollsQuery is available.
boolean	supportsRuledRaceQuery() Tests if a RaceQuery 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

matchRuledRaceId

void matchRuledRaceId(Id raceId,
                    boolean match)

Matches mapped to a race.

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.

clearRuledRaceIdTerms

void clearRuledRaceIdTerms()

Clears the race Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledRaceQuery

boolean supportsRuledRaceQuery()

Tests if a RaceQuery is available.

Returns:

true if a race query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledRaceQuery

RaceQuery getRuledRaceQuery()

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

Returns:

the race query

Throws:

UnimplementedException - supportsRuledRaceQuery() is false

Compliance:

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

matchAnyRuledRace

void matchAnyRuledRace(boolean match)

Matches constrainers mapped to any race.

Parameters:

match - true for constrainers mapped to any race, false to match constrainers mapped to no races

Compliance:

mandatory - This method must be implemented.

clearRuledRaceTerms

void clearRuledRaceTerms()

Clears the race query terms.

Compliance:

mandatory - This method must be implemented.

matchPollsId

void matchPollsId(Id pollsId,
                boolean match)

Matches constrainers 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.

getRaceConstrainerQueryRecord

RaceConstrainerQueryRecord getRaceConstrainerQueryRecord(Type raceConstrainerRecordType)
                                                         throws OperationFailedException

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

Parameters:

raceConstrainerRecordType - a race constrainer record type

Returns:

the race constrainer query record

Throws:

NullArgumentException - raceConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.