org.osid.mapping.path

Interface SpeedZoneSmartMapSession

All Superinterfaces:

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

public interface SpeedZoneSmartMapSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A SpeedZoneQuery can be retrieved from this session and mapped to this Map to create a virtual collection of SpeedZones. The speed zones may be sequenced using the SpeedZoneSearchOrder from this session.

This Map has a default query that matches any speed zone and a default search order that specifies no sequencing. The queries may be examined using a SpeedZoneQueryInspector. The query may be modified by converting the inspector back to a SpeedZoneQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applySpeedZoneQuery(SpeedZoneQuery speedZoneQuery) Applies a speed zone query to this map.
void	applySpeedZoneSequencing(SpeedZoneSearchOrder speedZoneSearchOrder) Applies a speed zone search order to this map.
boolean	canManageSmartMaps() Tests if this user can manage smart maps.
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.
SpeedZoneQuery	getSpeedZoneQueryFromInspector(SpeedZoneQueryInspector speedZoneQueryInspector) Gets a speed zone query from an inspector.
SpeedZoneSearchOrder	getSpeedZoneSearchOrder() Gets a speed zone search order.
SpeedZoneQueryInspector	inspecSpeedZoneQuery() Gets a speed zone query inspector for this map.

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.

canManageSmartMaps

boolean canManageSmartMaps()

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

Returns:

false if smart map management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getSpeedZoneQuery

SpeedZoneQuery getSpeedZoneQuery()

Gets a speed zone query.

Returns:

the speed zone query

Compliance:

mandatory - This method must be implemented.

getSpeedZoneSearchOrder

SpeedZoneSearchOrder getSpeedZoneSearchOrder()

Gets a speed zone search order.

Returns:

the speed zone search order

Compliance:

mandatory - This method must be implemented.

applySpeedZoneQuery

void applySpeedZoneQuery(SpeedZoneQuery speedZoneQuery)
                         throws OperationFailedException,
                                PermissionDeniedException

Applies a speed zone query to this map.

Parameters:

speedZoneQuery - the speed zone query

Throws:

NullArgumentException - speedZoneQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - speedZoneQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspecSpeedZoneQuery

SpeedZoneQueryInspector inspecSpeedZoneQuery()
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Gets a speed zone query inspector for this map.

Returns:

the speed zone query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applySpeedZoneSequencing

void applySpeedZoneSequencing(SpeedZoneSearchOrder speedZoneSearchOrder)
                              throws OperationFailedException,
                                     PermissionDeniedException

Applies a speed zone search order to this map.

Parameters:

speedZoneSearchOrder - the speed zone search order

Throws:

NullArgumentException - speedZoneSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - speedZoneSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getSpeedZoneQueryFromInspector

SpeedZoneQuery getSpeedZoneQueryFromInspector(SpeedZoneQueryInspector speedZoneQueryInspector)

Gets a speed zone query from an inspector.

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.