public interface SpeedZoneSearchSession extends SpeedZoneQuerySession
This session provides methods for searching among SpeedZone
objects. The search query is constructed using the
SpeedZoneQuery.
getSpeedZonesByQuery()
is the basic search method and
returns a list of SpeedZones.
A more advanced search may be
performed with getSpeedZonesBySearch().
It accepts a
SpeedZoneSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getSpeedZonesBySearch()
returns a
SpeedZoneSearchResults
that can be used to access the resulting
SpeedZoneList
or be used to perform a search within the
result set through SpeedZoneSearch.
This session defines views that offer differing behaviors for searching.
SpeedZones may have a query record indicated by their respective
record types. The query record is accessed via the SpeedZoneQuery.
Modifier and Type | Method and Description |
---|---|
SpeedZoneQuery |
getSpeedZoneQueryFromInspector(SpeedZoneQueryInspector speedZoneQueryInspector)
Gets a speed zone query from an inspector.
|
SpeedZoneSearchResults |
getSpeedZonesBySearch(SpeedZoneQuery speedZoneQuery,
SpeedZoneSearch speedZoneSearch)
Gets the search results matching the given search query using the
given search.
|
SpeedZoneSearch |
getSpeedZoneSearch()
Gets a speed zone search.
|
SpeedZoneSearchOrder |
getSpeedZoneSearchOrder()
Gets a speed zone search order.
|
canSearchSpeedZones, getMap, getMapId, getSpeedZoneQuery, getSpeedZonesByQuery, useFederatedMapView, useIsolatedMapView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
SpeedZoneSearch getSpeedZoneSearch()
mandatory
- This method must be implemented. SpeedZoneSearchOrder getSpeedZoneSearchOrder()
SpeedZoneSearchOrder
is supplied to a SpeedZoneSearch
to specify the
ordering of results.mandatory
- This method must be implemented. SpeedZoneSearchResults getSpeedZonesBySearch(SpeedZoneQuery speedZoneQuery, SpeedZoneSearch speedZoneSearch) throws OperationFailedException, PermissionDeniedException
speedZoneQuery
- the speed zone queryspeedZoneSearch
- the speed zone searchNullArgumentException
- speedZoneQuery
or speed zoneSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- speedZoneQuery
or
speed zoneSearch
is not of this servicemandatory
- This method must be implemented. SpeedZoneQuery getSpeedZoneQueryFromInspector(SpeedZoneQueryInspector speedZoneQueryInspector)
SpeedZoneSearchResults.
speedZoneQueryInspector
- a speed zone query inspectorNullArgumentException
- speedZoneQueryInspector
is null
UnsupportedException
- speedZoneQueryInspector
is not of this servicemandatory
- This method must be implemented.