org.osid.mapping.path

Interface SpeedZoneSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

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.

Methods inherited from interface org.osid.mapping.path.SpeedZoneQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.