org.osid.voting

Interface VoteQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface VoteQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining vote queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCandidateIdTerms() Gets the candidate Id query terms.
CandidateQueryInspector[]	getCandidateTerms() Gets the candidate query terms.
IntegerTerm[]	getMinimumVotesTerms() Gets the minimum votes query terms.
IdTerm[]	getPollsIdTerms() Gets the polls Id query terms.
PollsQueryInspector[]	getPollsTerms() Gets the polls query terms.
VoteQueryInspectorRecord	getVoteQueryInspectorRecord(Type voteRecordType) Gets the vote query inspector record corresponding to the given Vote record Type.
IdTerm[]	getVoterIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getVoterTerms() Gets the resource query terms.
IntegerRangeTerm[]	getVotesTerms() Gets the votes query terms.
IdTerm[]	getVotingAgentIdTerms() Gets the voting agent Id query terms.
AgentQueryInspector[]	getVotingAgentTerms() Gets the voting agent query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getCandidateIdTerms

IdTerm[] getCandidateIdTerms()

Gets the candidate Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCandidateTerms

CandidateQueryInspector[] getCandidateTerms()

Gets the candidate query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVoterIdTerms

IdTerm[] getVoterIdTerms()

Gets the resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVoterTerms

ResourceQueryInspector[] getVoterTerms()

Gets the resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVotingAgentIdTerms

IdTerm[] getVotingAgentIdTerms()

Gets the voting agent Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVotingAgentTerms

AgentQueryInspector[] getVotingAgentTerms()

Gets the voting agent query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVotesTerms

IntegerRangeTerm[] getVotesTerms()

Gets the votes query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMinimumVotesTerms

IntegerTerm[] getMinimumVotesTerms()

Gets the minimum votes 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.

getVoteQueryInspectorRecord

VoteQueryInspectorRecord getVoteQueryInspectorRecord(Type voteRecordType)
                                                     throws OperationFailedException

Gets the vote query inspector record corresponding to the given Vote record Type.

Parameters:

voteRecordType - a vote record type

Returns:

the vote query inspector record

Throws:

NullArgumentException - voteRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(voteRecordType) is false

Compliance:

mandatory - This method must be implemented.