Interface VoteQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

public interface VoteQuery
extends OsidRelationshipQuery

This is the query for searching votes. Each method match request produces an AND term while multiple invocations of a method produces a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearCandidateIdTerms()	Clears the candidate Id terms.
void	clearCandidateTerms()	Clears the candidate terms.
void	clearMinimumVotesTerms()	Clears the minimum votes terms.
void	clearPollsIdTerms()	Clears the polls Id terms.
void	clearPollsTerms()	Clears the polls terms.
void	clearVoterIdTerms()	Clears the voter agent Id terms.
void	clearVoterTerms()	Clears the voter terms.
void	clearVotesTerms()	Clears the votes terms.
void	clearVotingAgentIdTerms()	Clears the voting agent Id terms.
void	clearVotingAgentTerms()	Clears the voter terms.
CandidateQuery	getCandidateQuery()	Gets the query for a candidate.
PollsQuery	getPollsQuery()	Gets the query for a polls.
VoteQueryRecord	getVoteQueryRecord(Type voteRecordType)	Gets the vote query record corresponding to the given Vote record Type .
ResourceQuery	getVoterQuery()	Gets the query for a voter.
AgentQuery	getVotingAgentQuery()	Gets the query for a voter.
void	matchCandidateId(Id candidateId, boolean match)	Sets the candidate Id for this query.
void	matchMinimumVotes(long votes, boolean match)	Matches the number of minimum votes inclusive.
void	matchPollsId(Id pollsId, boolean match)	Sets the polls Id for this query to match terms assigned to polls.
void	matchVoterId(Id resourceId, boolean match)	Sets the resource Id for this query.
void	matchVotes(long from, long to, boolean match)	Matches the number of votes within the given range inclusive.
void	matchVotingAgentId(Id agentId, boolean match)	Sets the voting agent Id for this query.
boolean	supportsCandidateQuery()	Tests if a CandidateQuery is available for querying candidates.
boolean	supportsPollsQuery()	Tests if a PollsQuery is available.
boolean	supportsVoterQuery()	Tests if a ResourceQuery is available for querying candidates.
boolean	supportsVotingAgentQuery()	Tests if an AgentQuery is available for querying candidates.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

matchCandidateId

void matchCandidateId(Id candidateId,
 boolean match)

Sets the candidate Id for this query.

Parameters:

candidateId - a candidate Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - candidateId is null

Compliance:

mandatory - This method must be implemented.

clearCandidateIdTerms

void clearCandidateIdTerms()

Clears the candidate Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCandidateQuery

boolean supportsCandidateQuery()

Tests if a CandidateQuery is available for querying candidates.

Returns:

true if a candidate query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCandidateQuery

CandidateQuery getCandidateQuery()

Gets the query for a candidate. Multiple retrievals produce a nested OR term.

Returns:

the candidate query

Throws:

UnimplementedException - supportsCandidateQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCandidateQuery()} is {@code true} .

clearCandidateTerms

void clearCandidateTerms()

Clears the candidate terms.

Compliance:

mandatory - This method must be implemented.

matchVoterId

void matchVoterId(Id resourceId,
 boolean match)

Sets the resource Id for this query.

Parameters:

resourceId - a resource Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearVoterIdTerms

void clearVoterIdTerms()

Clears the voter agent Id terms.

Compliance:

mandatory - This method must be implemented.

supportsVoterQuery

boolean supportsVoterQuery()

Tests if a ResourceQuery is available for querying candidates.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getVoterQuery

ResourceQuery getVoterQuery()

Gets the query for a voter. Multiple retrievals produce a nested OR term.

Returns:

the resource query

Throws:

UnimplementedException - supportsVoterQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsVoterQuery()} is {@code true} .

clearVoterTerms

void clearVoterTerms()

Clears the voter terms.

Compliance:

mandatory - This method must be implemented.

matchVotingAgentId

void matchVotingAgentId(Id agentId,
 boolean match)

Sets the voting agent Id for this query.

Parameters:

agentId - a voting agent agent Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearVotingAgentIdTerms

void clearVotingAgentIdTerms()

Clears the voting agent Id terms.

Compliance:

mandatory - This method must be implemented.

supportsVotingAgentQuery

boolean supportsVotingAgentQuery()

Tests if an AgentQuery is available for querying candidates.

Returns:

true if a voting agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getVotingAgentQuery

AgentQuery getVotingAgentQuery()

Gets the query for a voter. Multiple retrievals produce a nested OR term.

Returns:

the agent query

Throws:

UnimplementedException - supportsVotingAgentQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsVotingAgentQuery()} is {@code true} .

clearVotingAgentTerms

void clearVotingAgentTerms()

Clears the voter terms.

Compliance:

mandatory - This method must be implemented.

matchVotes

void matchVotes(long from,
 long to,
 boolean match)

Matches the number of votes within the given range inclusive.

Parameters:

from - start of range

to - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

Compliance:

mandatory - This method must be implemented.

clearVotesTerms

void clearVotesTerms()

Clears the votes terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumVotes

void matchMinimumVotes(long votes,
 boolean match)

Matches the number of minimum votes inclusive.

Parameters:

votes - the numbe rof votes

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumVotesTerms

void clearMinimumVotesTerms()

Clears the minimum votes terms.

Compliance:

mandatory - This method must be implemented.

matchPollsId

void matchPollsId(Id pollsId,
 boolean match)

Sets the polls Id for this query to match terms assigned to polls.

Parameters:

pollsId - the polls Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - pollsId is null

Compliance:

mandatory - This method must be implemented.

clearPollsIdTerms

void clearPollsIdTerms()

Clears the polls Id terms.

Compliance:

mandatory - This method must be implemented.

supportsPollsQuery

boolean supportsPollsQuery()

Tests if a PollsQuery is available.

Returns:

true if a polls query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPollsQuery

PollsQuery getPollsQuery()

Gets the query for a polls. Multiple retrievals produce a nested OR term.

Returns:

the polls query

Throws:

UnimplementedException - supportsPollsQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsPollsQuery()} is {@code true} .

clearPollsTerms

void clearPollsTerms()

Clears the polls terms.

Compliance:

mandatory - This method must be implemented.

getVoteQueryRecord

VoteQueryRecord getVoteQueryRecord(Type voteRecordType)
                            throws OperationFailedException

Gets the vote query record corresponding to the given Vote record Type . Multiple retrievals produce a nested OR term.

Parameters:

voteRecordType - a vote query record type

Returns:

the vote query record

Throws:

NullArgumentException - voteRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(voteRecordType) is false

Compliance:

mandatory - This method must be implemented.