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

The search interface for governing speed zone searches.

MethodsearchAmongSpeedZones
Description

Execute this search among the given list of speed zones.

Parametersosid.id.IdListspeedZoneIdslist of speed zones
ErrorsNULL_ARGUMENT speedZoneIds is null
CompliancemandatoryThis method must be implemented.
MethodorderSpeedZoneResults
Description

Specify an ordering to the search results.

Parametersosid.mapping.path.SpeedZoneSearchOrderspeedZoneSearchOrderspeedZone search order
ErrorsNULL_ARGUMENT speedZoneSearchOrder is null
UNSUPPORTED speedZoneSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneSearchRecord
Description

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

Parametersosid.type.TypespeedZoneSearchRecordTypea speed zone search record type
Returnosid.mapping.path.records.SpeedZoneSearchRecordthe speed zone search record
ErrorsNULL_ARGUMENT speedZoneSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(speedZoneSearchRecordType) is false
CompliancemandatoryThis method must be implemented.