| Interface | osid.mapping.LocationSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidFederateableSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByDistance | ||
| Description |
Orders the results by distance. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLocationSearchOrderRecord | ||
| Description |
Gets the location search order record corresponding to
the given location record | ||
| Parameters | osid.type.Type | locationRecordType | a location record type |
| Return | osid.mapping.records.LocationSearchOrderRecord | the location search order record | |
| Errors | NULL_ARGUMENT | locationRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(locationRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |