OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.LocationSearch
Implementsosid.OsidSearch
Description

The search interface for governing location searches.

MethodsearchAmongLocations
Description

Execute this search among the given list of locations.

Parametersosid.id.IdListlocationIdslist of locations
ErrorsNULL_ARGUMENT locationIds is null
CompliancemandatoryThis method must be implemented.
MethodorderLocationResults
Description

Specify an ordering to the search results.

Parametersosid.mapping.LocationSearchOrderlocationSearchOrderlocation search order
ErrorsNULL_ARGUMENT locationSearchOrder is null
UNSUPPORTED locationSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetLocationSearchRecord
Description

Gets the record corresponding to the given location search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypelocationSearchRecordTypea location search record type
Returnosid.mapping.records.LocationSearchRecordthe location search record
ErrorsNULL_ARGUMENT locationSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(locationSearchRecordType) is false
CompliancemandatoryThis method must be implemented.