org.osid.voting.rules

Interface BallotConstrainerQueryInspector

All Superinterfaces:

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

public interface BallotConstrainerQueryInspector
extends OsidConstrainerQueryInspector

This is the query interface for examining ballot constrainer queries.

Method Summary

Methods

Modifier and Type	Method and Description
BallotConstrainerQueryInspectorRecord	getBallotConstrainerQueryInspectorRecord(Type ballotConstrainerRecordType) Gets the ballot constrainer query inspector record corresponding to the given BallotConstrainer record Type.
IdTerm[]	getPollsIdTerms() Gets the polls Id query terms.
PollsQueryInspector[]	getPollsTerms() Gets the polls query terms.
IdTerm[]	getRuledBallotIdTerms() Gets the ballot Id query terms.
BallotQueryInspector[]	getRuledBallotTerms() Gets the ballot 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

getRuledBallotIdTerms

IdTerm[] getRuledBallotIdTerms()

Gets the ballot Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledBallotTerms

BallotQueryInspector[] getRuledBallotTerms()

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

getBallotConstrainerQueryInspectorRecord

BallotConstrainerQueryInspectorRecord getBallotConstrainerQueryInspectorRecord(Type ballotConstrainerRecordType)
                                                                               throws OperationFailedException

Gets the ballot constrainer query inspector record corresponding to the given BallotConstrainer record Type.

Parameters:

ballotConstrainerRecordType - a ballot constrainer record type

Returns:

the ballot constrainer query inspector record

Throws:

NullArgumentException - ballotConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ballotConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.