public interface SpeedZoneEnablerQuerySession extends OsidSession
This session provides methods for searching among
SpeedZoneEnabler
objects. The search query is constructed using
the SpeedZoneEnablerQuery.
This session defines views that offer differing behaviors for searching.
Speed zone enablers may have a query record indicated by their
respective record types. The query record is accessed via the
SpeedZoneEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchSpeedZoneEnablers()
Tests if this user can perform
SpeedZoneEnabler
lookups. |
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.
|
SpeedZoneEnablerList |
getSpeedZoneEnablersByQuery(SpeedZoneEnablerQuery speedZoneEnablerQuery)
Gets a list of
SpeedZoneEnablers matching the given
speed zone enabler query. |
void |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
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 canSearchSpeedZoneEnablers()
SpeedZoneEnabler
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. SpeedZoneEnablerQuery getSpeedZoneEnablerQuery()
mandatory
- This method must be implemented. SpeedZoneEnablerList getSpeedZoneEnablersByQuery(SpeedZoneEnablerQuery speedZoneEnablerQuery) throws OperationFailedException, PermissionDeniedException
SpeedZoneEnablers
matching the given
speed zone enabler query.speedZoneEnablerQuery
- the sespeed zone enabler query SpeedZoneEnablerList
NullArgumentException
- speedZoneEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- speedZoneEnablerQuery
is not of this servicemandatory
- This method must be implemented.