OSID Logo
OSID Specifications
mapping package
Version 3.1.0
Interfaceosid.mapping.LocationSearch
Implementsosid.OsidSearch
Used Byosid.mapping.LocationSearchSession
Description

The search interface for governing location searches.

MethodsearchAmongLocations
Description

Execute this search among the given list of locations.

Parametersosid.id.IdListlocationIds list of locations
ErrorsNULL_ARGUMENT locationIds is null
Compliancemandatory This method must be implemented.
MethodorderLocationResults
Description

Specify an ordering to the search results.

Parametersosid.mapping.LocationSearchOrderlocationSearchOrder location search order
ErrorsNULL_ARGUMENT locationSearchOrder is null
UNSUPPORTED locationSearchOrder is not of this service
Compliancemandatory This 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.TypelocationSearchRecordType a location search record type
Returnosid.mapping.records.LocationSearchRecord the location search record
ErrorsNULL_ARGUMENT locationSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(locationSearchRecordType) is false
Compliancemandatory This method must be implemented.