org.osid.mapping.path

Interface SpeedZoneSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface SpeedZoneSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

Modifier and Type	Method and Description
SpeedZoneQueryInspector	getSpeedZoneQueryInspector() Gets the inspector for the query to examine the terms used in the search.
SpeedZoneList	getSpeedZones() Gets the speed zone list resulting from a search.
SpeedZoneSearchResultsRecord	getSpeedZoneSearchResultsRecord(Type speedZoneSearchRecordType) Gets the record corresponding to the given speed zone search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getSpeedZones

SpeedZoneList getSpeedZones()

Gets the speed zone list resulting from a search.

Returns:

the speed zone list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getSpeedZoneQueryInspector

SpeedZoneQueryInspector getSpeedZoneQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the speed zone query inspector

Compliance:

mandatory - This method must be implemented.

getSpeedZoneSearchResultsRecord

SpeedZoneSearchResultsRecord getSpeedZoneSearchResultsRecord(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 results record

Throws:

NullArgumentException - speedZoneSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(speedZoneSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.