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.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapId()
Map
Id
associated with this
session. Map Id
associated with this sessionmandatory
- This method must be implemented. Map getMap() throws OperationFailedException, PermissionDeniedException
Map
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartMaps()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart map management is not
authorized, true
otherwisemandatory
- This method must be implemented. SpeedZoneEnablerQuery getSpeedZoneEnablerQuery()
mandatory
- This method must be implemented. SpeedZoneEnablerSearchOrder getSpeedZoneEnablerSearchOrder()
mandatory
- This method must be implemented. void applySpeedZoneEnablerQuery(SpeedZoneEnablerQuery speedZoneEnablerQuery) throws OperationFailedException, PermissionDeniedException
speedZoneEnablerQuery
- the speed zone enabler queryNullArgumentException
- speedZoneEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- speedZoneEnablerQuery
not of this servicemandatory
- This method must be implemented. SpeedZoneEnablerQueryInspector inspectSpeedZoneEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applySpeedZoneEnablerSequencing(SpeedZoneEnablerSearchOrder speedZoneEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
speedZoneEnablerSearchOrder
- the speed zone enabler search
orderNullArgumentException
-
speedZoneEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
speedZoneEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. SpeedZoneEnablerQuery getSpeedZoneEnablerQueryFromInspector(SpeedZoneEnablerQueryInspector speedZoneEnablerQueryInspector)
speedZoneEnablerQueryInspector
- a speed zone enabler query
inspectorNullArgumentException
-
speedZoneEnablerQueryInspector
is null
UnsupportedException
-
speedZoneEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.