| Interface | osid.voting.rules.RaceProcessorSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidProcessorSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByMaximumWinners | ||
| Description |
Specified a preference for ordering the maximum winners value. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMinimumPercentageToWin | ||
| Description |
Specified a preference for ordering the minimum percentage to win value. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMinimumVotesToWin | ||
| Description |
Specified a preference for ordering the minimum votes to win value. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRaceProcessorSearchOrderRecord | ||
| Description |
Gets the race processor search order record
corresponding to the given race processor record | ||
| Parameters | osid.type.Type | raceProcessorRecordType | a race processor record type |
| Return | osid.voting.rules.records.RaceProcessorSearchOrderRecord | the race processor search order record | |
| Errors | NULL_ARGUMENT | raceProcessorRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(raceProcessorRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |