Interface SpeedZoneSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SpeedZoneSearch
extends OsidSearch

The search interface for governing speed zone searches.

Method Summary

Modifier and Type	Method	Description
SpeedZoneSearchRecord	getSpeedZoneSearchRecord(Type speedZoneSearchRecordType)	Gets the record corresponding to the given speed zone search record Type .
void	orderSpeedZoneResults(SpeedZoneSearchOrder speedZoneSearchOrder)	Specify an ordering to the search results.
void	searchAmongSpeedZones(IdList speedZoneIds)	Execute this search among the given list of speed zones.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongSpeedZones

void searchAmongSpeedZones(IdList speedZoneIds)

Execute this search among the given list of speed zones.

Parameters:

speedZoneIds - list of speed zones

Throws:

NullArgumentException - speedZoneIds is null

Compliance:

mandatory - This method must be implemented.

orderSpeedZoneResults

void orderSpeedZoneResults(SpeedZoneSearchOrder speedZoneSearchOrder)

Specify an ordering to the search results.

Parameters:

speedZoneSearchOrder - speedZone search order

Throws:

NullArgumentException - speedZoneSearchOrder is null

UnsupportedException - speedZoneSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSpeedZoneSearchRecord

SpeedZoneSearchRecord getSpeedZoneSearchRecord(Type speedZoneSearchRecordType)
                                        throws OperationFailedException

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

Parameters:

speedZoneSearchRecordType - a speed zone search record type

Returns:

the speed zone search record

Throws:

NullArgumentException - speedZoneSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(speedZoneSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.