Interface | osid.voting.VoteQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching votes. Each method match
request produces an | ||
Method | matchCandidateId | ||
Description |
Sets the candidate | ||
Parameters | osid.id.Id | candidateId | a candidate Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | candidateId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCandidateIdTerms | ||
Description |
Clears the candidate | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCandidateQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a candidate query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCandidateQuery | ||
Description |
Gets the query for a candidate. Multiple retrievals
produce a nested | ||
Return | osid.voting.CandidateQuery | the candidate query | |
Errors | UNIMPLEMENTED | supportsCandidateQuery() is false | |
Compliance | optional | This method must be implemented if supportsCandidateQuery()
is true. | |
Method | clearCandidateTerms | ||
Description |
Clears the candidate terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchVoterId | ||
Description |
Sets the resource | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearVoterIdTerms | ||
Description |
Clears the voter agent | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsVoterQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getVoterQuery | ||
Description |
Gets the query for a voter. Multiple retrievals produce
a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsVoterQuery() is false | |
Compliance | optional | This method must be implemented if supportsVoterQuery() is
true. | |
Method | clearVoterTerms | ||
Description |
Clears the voter terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchVotingAgentId | ||
Description |
Sets the voting agent | ||
Parameters | osid.id.Id | agentId | a voting agent agent Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | agentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearVotingAgentIdTerms | ||
Description |
Clears the voting agent | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsVotingAgentQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a voting agent query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getVotingAgentQuery | ||
Description |
Gets the query for a voter. Multiple retrievals produce
a nested | ||
Return | osid.authentication.AgentQuery | the agent query | |
Errors | UNIMPLEMENTED | supportsVotingAgentQuery() is false | |
Compliance | optional | This method must be implemented if supportsVotingAgentQuery()
is true. | |
Method | clearVotingAgentTerms | ||
Description |
Clears the voter terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchVotes | ||
Description |
Matches the number of votes within the given range inclusive. | ||
Parameters | integer | from | start of range |
integer | to | end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
Compliance | mandatory | This method must be implemented. | |
Method | clearVotesTerms | ||
Description |
Clears the votes terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumVotes | ||
Description |
Matches the number of minimum votes inclusive. | ||
Parameters | integer | votes | the numbe rof votes |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumVotesTerms | ||
Description |
Clears the minimum votes terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchPollsId | ||
Description |
Sets the polls | ||
Parameters | osid.id.Id | pollsId | the polls Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | pollsId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearPollsIdTerms | ||
Description |
Clears the polls | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsPollsQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a polls query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPollsQuery | ||
Description |
Gets the query for a polls. Multiple retrievals produce
a nested | ||
Return | osid.voting.PollsQuery | the polls query | |
Errors | UNIMPLEMENTED | supportsPollsQuery() is false | |
Compliance | optional | This method must be implemented if supportsPollsQuery() is
true. | |
Method | clearPollsTerms | ||
Description |
Clears the polls terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getVoteQueryRecord | ||
Description |
Gets the vote query record corresponding to the given
| ||
Parameters | osid.type.Type | voteRecordType | a vote query record type |
Return | osid.voting.records.VoteQueryRecord | the vote query record | |
Errors | NULL_ARGUMENT | voteRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(voteRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |