OSID Logo
OSID Specifications
mapping package
Version 3.1.0
Interfaceosid.mapping.LocationSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidFederateableSearchOrder
Used Byosid.calendaring.EventSearchOrder
osid.calendaring.OffsetEventSearchOrder
osid.calendaring.ScheduleSearchOrder
osid.inventory.ItemSearchOrder
osid.mapping.LocationSearchSession
osid.mapping.LocationSmartMapSession
Description

An interface for specifying the ordering of search results.

MethodorderByDistance
Description

Orders the results by distance.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodgetLocationSearchOrderRecord
Description

Gets the location search order record corresponding to the given location record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypelocationRecordType a location record type
Returnosid.mapping.records.LocationSearchOrderRecord the location search order record
ErrorsNULL_ARGUMENT locationRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(locationRecordType) is false
Compliancemandatory This method must be implemented.