Interface SpeedZoneEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface SpeedZoneEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
SpeedZoneEnablerQueryInspector	getSpeedZoneEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
SpeedZoneEnablerList	getSpeedZoneEnablers()	Gets the SpeedZoneEnablerList resulting from a search.
SpeedZoneEnablerSearchResultsRecord	getSpeedZoneEnablerSearchResultsRecord(Type speedZoneEnablerSearchRecordType)	Gets the speed zone enabler search results record corresponding to the given speed zone enabler search record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getSpeedZoneEnablers

SpeedZoneEnablerList getSpeedZoneEnablers()

Gets the SpeedZoneEnablerList resulting from a search.

Returns:

the speed zone enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablerQueryInspector

SpeedZoneEnablerQueryInspector getSpeedZoneEnablerQueryInspector()

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

Returns:

the speed zone enabler query inspector

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablerSearchResultsRecord

SpeedZoneEnablerSearchResultsRecord getSpeedZoneEnablerSearchResultsRecord(Type speedZoneEnablerSearchRecordType)
                                                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

speedZoneEnablerSearchRecordType - a speed zone enabler search record type

Returns:

the speed zone enabler search results record

Throws:

NullArgumentException - speedZoneEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(speedZoneEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.