org.osid.voting.rules

Interface RaceConstrainerEnablerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidEnablerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable

public interface RaceConstrainerEnablerQuery
extends OsidEnablerQuery

This is the query for searching race constrainer enablers. 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	clearRuledRaceConstrainerIdTerms() Clears the race constrainer Id query terms.
void	clearRuledRaceConstrainerTerms() Clears the race constrainer query terms.
PollsQuery	getPollsQuery() Gets the query for a polls.
RaceConstrainerEnablerQueryRecord	getRaceConstrainerEnablerQueryRecord(Type raceConstrainerEnablerRecordType) Gets the race constrainer enabler query record corresponding to the given RaceConstrainerEnabler record Type.
RaceConstrainerQuery	getRuledRaceConstrainerQuery() Gets the query for a race constrainer.
void	matchAnyRuledRaceConstrainer(boolean match) Matches enablers mapped to any race constrainer.
void	matchPollsId(Id pollsId, boolean match) Matches enablers mapped to the polls.
void	matchRuledRaceConstrainerId(Id raceConstrainerId, boolean match) Matches enablers mapped to the race constrainer.
boolean	supportsPollsQuery() Tests if a PollsQuery is available.
boolean	supportsRuledRaceConstrainerQuery() Tests if a RaceConstrainerQuery is available.

Methods inherited from interface org.osid.OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery

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

Methods inherited from interface org.osid.OsidTemporalQuery

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

Method Detail

matchRuledRaceConstrainerId

void matchRuledRaceConstrainerId(Id raceConstrainerId,
                               boolean match)

Matches enablers mapped to the race constrainer.

Parameters:

raceConstrainerId - the race constrainer Id

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

Throws:

NullArgumentException - raceConstrainerId is null

Compliance:

mandatory - This method must be implemented.

clearRuledRaceConstrainerIdTerms

void clearRuledRaceConstrainerIdTerms()

Clears the race constrainer Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledRaceConstrainerQuery

boolean supportsRuledRaceConstrainerQuery()

Tests if a RaceConstrainerQuery is available.

Returns:

true if a race constrainer query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledRaceConstrainerQuery

RaceConstrainerQuery getRuledRaceConstrainerQuery()

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

Returns:

the race constrainer query

Throws:

UnimplementedException - supportsRuledRaceConstrainerQuery() is false

Compliance:

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

matchAnyRuledRaceConstrainer

void matchAnyRuledRaceConstrainer(boolean match)

Matches enablers mapped to any race constrainer.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledRaceConstrainerTerms

void clearRuledRaceConstrainerTerms()

Clears the race constrainer query terms.

Compliance:

mandatory - This method must be implemented.

matchPollsId

void matchPollsId(Id pollsId,
                boolean match)

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

getRaceConstrainerEnablerQueryRecord

RaceConstrainerEnablerQueryRecord getRaceConstrainerEnablerQueryRecord(Type raceConstrainerEnablerRecordType)
                                                                       throws OperationFailedException

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

Parameters:

raceConstrainerEnablerRecordType - a race constrainer enabler record type

Returns:

the race constrainer enabler query record

Throws:

NullArgumentException - raceConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.