| Interface | osid.voting.RaceSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidGovernatorSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Description | 
                 An interface for specifying the ordering of search results.  | ||
| Method | orderByBallot | ||
| Description | 
                     Orders the results by the ballot.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsBallotSearchOrder | ||
| Description | 
                     Tests if a ballot search order is available.  | ||
| Return | boolean |  true  if a ballot search order is available,  false 
 otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBallotSearchOrder | ||
| Description | 
                     Gets the ballot search order.  | ||
| Return | osid.voting.BallotSearchOrder | the ballot search order | |
| Errors | ILLEGAL_STATE |  supportsBallotSearchOrder()  is  false   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRaceSearchOrderRecord | ||
| Description | 
                     Gets the polls search order record corresponding to the 
                    given race record   | ||
| Parameters | osid.type.Type | raceRecordType | a race record type | 
| Return | osid.voting.records.RaceSearchOrderRecord | the race search order record | |
| Errors | NULL_ARGUMENT |  raceRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(raceRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |