OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.LocationSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidFederateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByDistance
Description

Orders the results by distance.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis 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.TypelocationRecordTypea location record type
Returnosid.mapping.records.LocationSearchOrderRecordthe location search order record
ErrorsNULL_ARGUMENT locationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(locationRecordType) is false
CompliancemandatoryThis method must be implemented.