org.osid.voting

Interface BallotQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidGovernatorQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector, OsidTemporalQueryInspector

public interface BallotQueryInspector
extends OsidGovernatorQueryInspector, OsidTemporalQueryInspector

This is the query inspector for examining ballot queries.

Method Summary

Methods

Modifier and Type	Method and Description
BallotQueryInspectorRecord	getBallotQueryInspectorRecord(Type ballotRecordType) Gets the ballot query inspector record corresponding to the given Ballot record Type.
IdTerm[]	getPollsIdTerms() Gets the polls Id query terms.
PollsQueryInspector[]	getPollsTerms() Gets the polls query terms.
IdTerm[]	getRaceIdTerms() Gets the race Id query terms.
RaceQueryInspector[]	getRaceTerms() Gets the race query terms.
BooleanTerm[]	getRevoteTerms() Gets the revote query terms.

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

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getRevoteTerms

BooleanTerm[] getRevoteTerms()

Gets the revote query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRaceIdTerms

IdTerm[] getRaceIdTerms()

Gets the race Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRaceTerms

RaceQueryInspector[] getRaceTerms()

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.

getBallotQueryInspectorRecord

BallotQueryInspectorRecord getBallotQueryInspectorRecord(Type ballotRecordType)
                                                         throws OperationFailedException

Gets the ballot query inspector record corresponding to the given Ballot record Type.

Parameters:

ballotRecordType - a ballot record type

Returns:

the ballot query inspector record

Throws:

NullArgumentException - ballotRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ballotRecordType) is false

Compliance:

mandatory - This method must be implemented.