org.osid.voting.rules

Interface RaceProcessorQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidProcessorQueryInspector, OsidQueryInspector, OsidRuleQueryInspector

public interface RaceProcessorQueryInspector
extends OsidProcessorQueryInspector

This is the query inspector for examining race processor queries.

Method Summary

Methods

Modifier and Type	Method and Description
CardinalRangeTerm[]	getMaximumWinnersTerms() Gets the maximum winners query terms.
CardinalRangeTerm[]	getMinimumPercentageToWinTerms() Gets the minimum percentage to win query terms.
CardinalRangeTerm[]	getMinimumVotesToWinTerms() Gets the minimum votes to win query terms.
IdTerm[]	getPollsIdTerms() Gets the polls Id query terms.
PollsQueryInspector[]	getPollsTerms() Gets the polls query terms.
RaceProcessorQueryInspectorRecord	getRaceProcessorQueryInspectorRecord(Type raceProcessorRecordType) Gets the race processor query inspector record corresponding to the given RaceProcessor record Type.
IdTerm[]	getRuledRaceIdTerms() Gets the race Id query terms.
RaceQueryInspector[]	getRuledRaceTerms() Gets the race query terms.

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Method Detail

getMaximumWinnersTerms

CardinalRangeTerm[] getMaximumWinnersTerms()

Gets the maximum winners query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMinimumPercentageToWinTerms

CardinalRangeTerm[] getMinimumPercentageToWinTerms()

Gets the minimum percentage to win query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMinimumVotesToWinTerms

CardinalRangeTerm[] getMinimumVotesToWinTerms()

Gets the minimum votes to win query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledRaceIdTerms

IdTerm[] getRuledRaceIdTerms()

Gets the race Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledRaceTerms

RaceQueryInspector[] getRuledRaceTerms()

Gets the race query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPollsIdTerms

IdTerm[] getPollsIdTerms()

Gets the polls Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPollsTerms

PollsQueryInspector[] getPollsTerms()

Gets the polls query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRaceProcessorQueryInspectorRecord

RaceProcessorQueryInspectorRecord getRaceProcessorQueryInspectorRecord(Type raceProcessorRecordType)
                                                                       throws OperationFailedException

Gets the race processor query inspector record corresponding to the given RaceProcessor record Type.

Parameters:

raceProcessorRecordType - a race processor record type

Returns:

the race processor query inspector record

Throws:

NullArgumentException - raceProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.