Interface SpeedZoneSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, SpeedZoneQuerySession

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.

• federated map view: searches include speed zones in maps of which this map is an ancestor in the map hierarchy
• isolated map view: searches are restricted to speed zones in this map

SpeedZones may have a query record indicated by their respective record types. The query record is accessed via the SpeedZoneQuery.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface SpeedZoneQuerySession

canSearchSpeedZones, getMap, getMapId, getSpeedZoneQuery, getSpeedZonesByQuery, useFederatedMapView, useIsolatedMapView

Modifier and Type	Method	Description
boolean	canSearchSpeedZones()	Tests if this user can perform SpeedZone lookups.
Map	getMap()	Gets the Map associated with this session.
Id	getMapId()	Gets the Map Id associated with this session.
SpeedZoneQuery	getSpeedZoneQuery()	Gets a speed zone query.
SpeedZoneList	getSpeedZonesByQuery(SpeedZoneQuery speedZoneQuery)	Gets a list of SpeedZones matching the given speed zone query.
void	useFederatedMapView()	Federates the view for methods in this session.
void	useIsolatedMapView()	Isolates the view for methods in this session.

Method Details

getSpeedZoneSearch

SpeedZoneSearch getSpeedZoneSearch()

Gets a speed zone search.

Returns:

the speed zone search

Compliance:

mandatory - This method must be implemented.

getSpeedZoneSearchOrder

SpeedZoneSearchOrder getSpeedZoneSearchOrder()

Gets a speed zone search order. The SpeedZoneSearchOrder is supplied to a SpeedZoneSearch to specify the ordering of results.

Returns:

the speed zone search order

Compliance:

mandatory - This method must be implemented.

getSpeedZonesBySearch

SpeedZoneSearchResults getSpeedZonesBySearch(SpeedZoneQuery speedZoneQuery,
 SpeedZoneSearch speedZoneSearch)
                                      throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

speedZoneQuery - the speed zone query

speedZoneSearch - the speed zone search

Returns:

the returned search results

Throws:

NullArgumentException - speedZoneQuery or speed zoneSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - speedZoneQuery or speed zoneSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getSpeedZoneQueryFromInspector

SpeedZoneQuery getSpeedZoneQueryFromInspector(SpeedZoneQueryInspector speedZoneQueryInspector)

Gets a speed zone query from an inspector. The inspector is available from a SpeedZoneSearchResults.

Parameters:

speedZoneQueryInspector - a speed zone query inspector

Returns:

the speed zone query

Throws:

NullArgumentException - speedZoneQueryInspector is null

UnsupportedException - speedZoneQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.