| Interface | osid.voting.BallotSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing ballot searches. | ||
| Method | searchAmongBallots | ||
| Description |
Execute this search among the given list of ballots. | ||
| Parameters | osid.id.IdList | ballotIds | list of ballot Ids |
| Errors | NULL_ARGUMENT | ballotIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBallotResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.voting.BallotSearchOrder | ballotSearchOrder | ballot search order |
| Errors | NULL_ARGUMENT | order is null | |
| UNSUPPORTED | order is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getBallotSearchRecord | ||
| Description |
Gets the ballot search record corresponding to the
given ballot search record | ||
| Parameters | osid.type.Type | ballotSearchRecordType | a ballot search record type |
| Return | osid.voting.records.BallotSearchRecord | the ballot search record | |
| Errors | NULL_ARGUMENT | ballotSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordTypeType(ballotSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |