org.osid.mapping.path

Interface SpeedZoneQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

SpeedZoneSearchSession

public interface SpeedZoneQuerySession
extends OsidSession

This session provides methods for searching among SpeedZone objects. The search query is constructed using the SpeedZoneQuery.

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
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.

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

getMapId

Id getMapId()

Gets the Map Id associated with this session.

Returns:

the Map Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMap

Map getMap()
           throws OperationFailedException,
                  PermissionDeniedException

Gets the Map associated with this session.

Returns:

the map

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchSpeedZones

boolean canSearchSpeedZones()

Tests if this user can perform SpeedZone lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedMapView

void useFederatedMapView()

Federates the view for methods in this session. A federated view will include speed zones in maps which are children of this map in the map hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedMapView

void useIsolatedMapView()

Isolates the view for methods in this session. An isolated view restricts lookups to this map only.

Compliance:

mandatory - This method is must be implemented.

getSpeedZoneQuery

SpeedZoneQuery getSpeedZoneQuery()

Gets a speed zone query.

Returns:

the speed zone query

Compliance:

mandatory - This method must be implemented.

getSpeedZonesByQuery

SpeedZoneList getSpeedZonesByQuery(SpeedZoneQuery speedZoneQuery)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets a list of SpeedZones matching the given speed zone query.

Parameters:

speedZoneQuery - the zpeed zone query

Returns:

the returned SpeedZoneList

Throws:

NullArgumentException - speedZoneQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - speedZoneQuery is not of this service

Compliance:

mandatory - This method must be implemented.