Interface | osid.voting.CandidateQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching candidates. Each method
specifies an | ||
Method | matchRaceId | ||
Description |
Sets the race | ||
Parameters | osid.id.Id | raceId | a race Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | raceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRaceIdTerms | ||
Description |
Clears the race | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRaceQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a race query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRaceQuery | ||
Description |
Gets the query for a race. Multiple retrievals produce
a nested | ||
Return | osid.voting.RaceQuery | the race query | |
Errors | UNIMPLEMENTED | supportsRaceQuery() is false | |
Compliance | optional | This method must be implemented if supportsRaceQuery() is
true. | |
Method | clearRaceTerms | ||
Description |
Clears the race terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchResourceId | ||
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 | clearResourceIdTerms | ||
Description |
Clears the resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsResourceQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceQuery | ||
Description |
Gets the query for a resource. Multiple retrievals
produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsResourceQuery() is false | |
Compliance | optional | This method must be implemented if supportsResourceQuery()
is true. | |
Method | clearResourceTerms | ||
Description |
Clears the resource terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchVoteId | ||
Description |
Sets the vote | ||
Parameters | osid.id.Id | voteId | the vote Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | voteId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearVoteIdTerms | ||
Description |
Clears the vote | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsVoteQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a vote query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getVoteQuery | ||
Description |
Gets the query for a vote. Multiple retrievals produce
a nested | ||
Return | osid.voting.VoteQuery | the vote query | |
Errors | UNIMPLEMENTED | supportsVoteQuery() is false | |
Compliance | optional | This method must be implemented if supportsVoteQuery() is
true. | |
Method | matchAnyVote | ||
Description |
Matches candidates with any vote. | ||
Parameters | boolean | match | true to match any vote, false to match
candidates with no votes |
Compliance | mandatory | This method must be implemented. | |
Method | clearVoteTerms | ||
Description |
Clears the vote 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 | getCandidateQueryRecord | ||
Description |
Gets the candidate query record corresponding to the
given | ||
Parameters | osid.type.Type | candidateRecordType | a candidate record type |
Return | osid.voting.records.CandidateQueryRecord | the candidate query record | |
Errors | NULL_ARGUMENT | candidateRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(candidateRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |