org.osid.voting.rules

Interface BallotConstrainerEnablerQuery

All Superinterfaces:

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

public interface BallotConstrainerEnablerQuery
extends OsidEnablerQuery

This is the query for searching ballot constrainer enablers. 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	clearRuledBallotConstrainerIdTerms() Clears the ballot constrainer Id query terms.
void	clearRuledBallotConstrainerTerms() Clears the ballot constrainer query terms.
BallotConstrainerEnablerQueryRecord	getBallotConstrainerEnablerQueryRecord(Type ballotConstrainerEnablerRecordType) Gets the ballot constrainer enabler query record corresponding to the given BallotConstrainerEnabler record Type.
PollsQuery	getPollsQuery() Gets the query for a polls.
BallotConstrainerQuery	getRuledBallotConstrainerQuery() Gets the query for a ballot constrainer.
void	matchAnyRuledBallotConstrainer(boolean match) Matches enablers mapped to any ballot constrainer.
void	matchPollsId(Id pollsId, boolean match) Matches enablers mapped to the polls.
void	matchRuledBallotConstrainerId(Id ballotConstrainerId, boolean match) Matches enablers mapped to the ballot constrainer.
boolean	supportsPollsQuery() Tests if a PollsQuery is available.
boolean	supportsRuledBallotConstrainerQuery() Tests if a BallotConstrainerQuery 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

matchRuledBallotConstrainerId

void matchRuledBallotConstrainerId(Id ballotConstrainerId,
                                 boolean match)

Matches enablers mapped to the ballot constrainer.

Parameters:

ballotConstrainerId - the ballot constrainer Id

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

Throws:

NullArgumentException - ballotConstrainerId is null

Compliance:

mandatory - This method must be implemented.

clearRuledBallotConstrainerIdTerms

void clearRuledBallotConstrainerIdTerms()

Clears the ballot constrainer Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledBallotConstrainerQuery

boolean supportsRuledBallotConstrainerQuery()

Tests if a BallotConstrainerQuery is available.

Returns:

true if a ballot constrainer query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledBallotConstrainerQuery

BallotConstrainerQuery getRuledBallotConstrainerQuery()

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

Returns:

the ballot constrainer query

Throws:

UnimplementedException - supportsRuledBallotConstrainerQuery() is false

Compliance:

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

matchAnyRuledBallotConstrainer

void matchAnyRuledBallotConstrainer(boolean match)

Matches enablers mapped to any ballot constrainer.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledBallotConstrainerTerms

void clearRuledBallotConstrainerTerms()

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

getBallotConstrainerEnablerQueryRecord

BallotConstrainerEnablerQueryRecord getBallotConstrainerEnablerQueryRecord(Type ballotConstrainerEnablerRecordType)
                                                                           throws OperationFailedException

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

Parameters:

ballotConstrainerEnablerRecordType - a ballot constrainer enabler record type

Returns:

the ballot constrainer enabler query record

Throws:

NullArgumentException - ballotConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ballotConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.