org.osid.mapping.path.rules

Interface SpeedZoneEnablerSmartMapSession

All Superinterfaces:

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

public interface SpeedZoneEnablerSmartMapSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic map. a SpeedZoneEnablerQuery can be retrieved from this session and mapped to this Map to create a virtual collection of speed zone enablers. The speed zone enablers may be sequenced using the SpeedZoneEnablerSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applySpeedZoneEnablerQuery(SpeedZoneEnablerQuery speedZoneEnablerQuery) Applies a speed zone enabler query to this map.
void	applySpeedZoneEnablerSequencing(SpeedZoneEnablerSearchOrder speedZoneEnablerSearchOrder) Applies a speed zone enabler search order to this map.
boolean	canManageSmartMaps() Tests if this user can manage smart map.
Map	getMap() Gets the Map associated with this session.
Id	getMapId() Gets the Map Id associated with this session.
SpeedZoneEnablerQuery	getSpeedZoneEnablerQuery() Gets a speed zone enabler query.
SpeedZoneEnablerQuery	getSpeedZoneEnablerQueryFromInspector(SpeedZoneEnablerQueryInspector speedZoneEnablerQueryInspector) Gets a speed zone enabler query from an inspector.
SpeedZoneEnablerSearchOrder	getSpeedZoneEnablerSearchOrder() Gets a speed zone enabler search order.
SpeedZoneEnablerQueryInspector	inspectSpeedZoneEnablerQuery() Gets a speed zone enabler 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 map. 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.

getSpeedZoneEnablerQuery

SpeedZoneEnablerQuery getSpeedZoneEnablerQuery()

Gets a speed zone enabler query.

Returns:

the speed zone enabler query

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablerSearchOrder

SpeedZoneEnablerSearchOrder getSpeedZoneEnablerSearchOrder()

Gets a speed zone enabler search order.

Returns:

the speed zone enabler search order

Compliance:

mandatory - This method must be implemented.

applySpeedZoneEnablerQuery

void applySpeedZoneEnablerQuery(SpeedZoneEnablerQuery speedZoneEnablerQuery)
                                throws OperationFailedException,
                                       PermissionDeniedException

Applies a speed zone enabler query to this map.

Parameters:

speedZoneEnablerQuery - the speed zone enabler query

Throws:

NullArgumentException - speedZoneEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - speedZoneEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectSpeedZoneEnablerQuery

SpeedZoneEnablerQueryInspector inspectSpeedZoneEnablerQuery()
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

Gets a speed zone enabler query inspector for this map.

Returns:

the speed zone enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applySpeedZoneEnablerSequencing

void applySpeedZoneEnablerSequencing(SpeedZoneEnablerSearchOrder speedZoneEnablerSearchOrder)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Applies a speed zone enabler search order to this map.

Parameters:

speedZoneEnablerSearchOrder - the speed zone enabler search order

Throws:

NullArgumentException - speedZoneEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - speedZoneEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablerQueryFromInspector

SpeedZoneEnablerQuery getSpeedZoneEnablerQueryFromInspector(SpeedZoneEnablerQueryInspector speedZoneEnablerQueryInspector)

Gets a speed zone enabler query from an inspector.

Parameters:

speedZoneEnablerQueryInspector - a speed zone enabler query inspector

Returns:

the speed zone enabler query

Throws:

NullArgumentException - speedZoneEnablerQueryInspector is null

UnsupportedException - speedZoneEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.