Interface VoteQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector
This is the query inspector for examining vote queries.
Like all OsidQueryInspectors, VoteQueryInspector is
stateful and must not be accessed by multiple processing threads.
-
Method Summary
Modifier and TypeMethodDescriptionIdTerm[]Gets the candidateIdquery terms.Gets the candidate query terms.Gets the minimum votes query terms.IdTerm[]Gets the pollsIdquery terms.Gets the polls query terms.getVoteQueryInspectorRecord(Type voteRecordType) Gets the vote query inspector record corresponding to the givenVoterecordType.IdTerm[]Gets the resourceIdquery terms.Gets the resource query terms.Gets the votes query terms.IdTerm[]Gets the voting agentIdquery terms.Gets the voting agent query terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeMethods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsMethods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsMethods inherited from interface OsidRelationshipQueryInspector
getEndReasonIdTerms, getEndReasonTermsMethods inherited from interface OsidTemporalQueryInspector
getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms
-
Method Details
-
getCandidateIdTerms
IdTerm[] getCandidateIdTerms()Gets the candidateIdquery 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 resourceIdquery 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 agentIdquery 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 pollsIdquery 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 givenVoterecordType.- Parameters:
voteRecordType- a vote record type- Returns:
- the vote query inspector record
- Throws:
NullArgumentException-voteRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(voteRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-