Interface SpeedZoneEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SpeedZoneEnablerSearch
extends OsidSearch

The search interface for governing speed zone enabler searches.

Method Summary

Modifier and Type	Method	Description
SpeedZoneEnablerSearchRecord	getSpeedZoneEnablerSearchRecord(Type speedZoneEnablerSearchRecordType)	Gets the speed zone enabler search record corresponding to the given speed zone enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderSpeedZoneEnablerResults(SpeedZoneEnablerSearchOrder speedZoneEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongSpeedZoneEnablers(IdList speedZoneEnablerIds)	Execute this search among the given list of speed zone enablers.

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

searchAmongSpeedZoneEnablers

void searchAmongSpeedZoneEnablers(IdList speedZoneEnablerIds)

Execute this search among the given list of speed zone enablers.

Parameters:

speedZoneEnablerIds - list of speed zone enablers

Throws:

NullArgumentException - speedZoneEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderSpeedZoneEnablerResults

void orderSpeedZoneEnablerResults(SpeedZoneEnablerSearchOrder speedZoneEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

speedZoneEnablerSearchOrder - speed zone enabler search order

Throws:

NullArgumentException - speedZoneEnablerSearchOrder is null

UnsupportedException - speedZoneEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablerSearchRecord

SpeedZoneEnablerSearchRecord getSpeedZoneEnablerSearchRecord(Type speedZoneEnablerSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

speedZoneEnablerSearchRecordType - a speed zone enabler search record type

Returns:

the speed zone enabler search record

Throws:

NullArgumentException - speedZoneEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(speedZoneEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.