Interface | osid.voting.rules.BallotConstrainerQuery | ||
---|---|---|---|
Implements | osid.OsidConstrainerQuery | ||
Description |
This is the query for searching ballot constrainers. Each
method match specifies an | ||
Method | matchRuledBallotId | ||
Description |
Matches rules mapped to a ballot. | ||
Parameters | osid.id.Id | ballotId | the ballot Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | ballotId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledBallotIdTerms | ||
Description |
Clears the ballot | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledBallotQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a ballot query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledBallotQuery | ||
Description |
Gets the query for a ballot. Multiple retrievals
produce a nested | ||
Return | osid.voting.BallotQuery | the ballot query | |
Errors | UNIMPLEMENTED | supportsRuledBallotQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledBallotQuery()
is true. | |
Method | matchAnyRuledBallot | ||
Description |
Matches rules mapped to any ballot. | ||
Parameters | boolean | match | true for rules mapped to any ballot, false to
match rules mapped to no ballots |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledBallotTerms | ||
Description |
Clears the ballot query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchPollsId | ||
Description |
Matches rules mapped to 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 query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBallotConstrainerQueryRecord | ||
Description |
Gets the ballot constrainer query record corresponding
to the given | ||
Parameters | osid.type.Type | ballotConstrainerRecordType | a ballot constrainer record type |
Return | osid.voting.rules.records.BallotConstrainerQueryRecord | the ballot constrainer query record | |
Errors | NULL_ARGUMENT | ballotConstrainerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(ballotConstrainerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |