public interface LocationSearchOrder extends OsidObjectSearchOrder, OsidFederateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
LocationSearchOrderRecord |
getLocationSearchOrderRecord(Type locationRecordType)
Gets the location search order record corresponding to the given
location record
Type. |
void |
orderByDistance(SearchOrderStyle style)
Orders the results by distance.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByDistance(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. LocationSearchOrderRecord getLocationSearchOrderRecord(Type locationRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.locationRecordType
- a location record typeNullArgumentException
- locationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(locationRecordType)
is false
mandatory
- This method must be implemented.