org.osid.voting.rules

Interface RaceProcessorEnablerQuery

All Superinterfaces:

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

public interface RaceProcessorEnablerQuery
extends OsidEnablerQuery

This is the query for searching race processor 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	clearRuledRaceProcessorIdTerms() Clears the race processor Id query terms.
void	clearRuledRaceProcessorTerms() Clears the race processor query terms.
PollsQuery	getPollsQuery() Gets the query for a polls.
RaceProcessorEnablerQueryRecord	getRaceProcessorEnablerQueryRecord(Type raceProcessorEnablerRecordType) Gets the race processor enabler query record corresponding to the given RaceProcessorEnabler record Type.
RaceProcessorQuery	getRuledRaceProcessorQuery() Gets the query for a race processor.
void	matchAnyRuledRaceProcessor(boolean match) Matches enablers mapped to any race processor.
void	matchPollsId(Id pollsId, boolean match) Matches enablers mapped to the polls.
void	matchRuledRaceProcessorId(Id raceProcessorId, boolean match) Matches enablers mapped to the race processor.
boolean	supportsPollsQuery() Tests if a PollsQuery is available.
boolean	supportsRuledRaceProcessorQuery() Tests if a RaceProcessorQuery 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

matchRuledRaceProcessorId

void matchRuledRaceProcessorId(Id raceProcessorId,
                             boolean match)

Matches enablers mapped to the race processor.

Parameters:

raceProcessorId - the race processor Id

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

Throws:

NullArgumentException - raceProcessorId is null

Compliance:

mandatory - This method must be implemented.

clearRuledRaceProcessorIdTerms

void clearRuledRaceProcessorIdTerms()

Clears the race processor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledRaceProcessorQuery

boolean supportsRuledRaceProcessorQuery()

Tests if a RaceProcessorQuery is available.

Returns:

true if a race processor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledRaceProcessorQuery

RaceProcessorQuery getRuledRaceProcessorQuery()

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

Returns:

the race processor query

Throws:

UnimplementedException - supportsRuledRaceProcessorQuery() is false

Compliance:

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

matchAnyRuledRaceProcessor

void matchAnyRuledRaceProcessor(boolean match)

Matches enablers mapped to any race processor.

Parameters:

match - true for enablers mapped to any race processor, false to match enablers mapped to no race processors

Compliance:

mandatory - This method must be implemented.

clearRuledRaceProcessorTerms

void clearRuledRaceProcessorTerms()

Clears the race processor 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.

getRaceProcessorEnablerQueryRecord

RaceProcessorEnablerQueryRecord getRaceProcessorEnablerQueryRecord(Type raceProcessorEnablerRecordType)
                                                                   throws OperationFailedException

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

Parameters:

raceProcessorEnablerRecordType - a race processor enabler record type

Returns:

the race processor enabler query record

Throws:

NullArgumentException - raceProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.