public interface SpeedZoneEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve SpeedZoneEnabler
to SpeedZone
mappings. a SpeedZone
with multiple SpeedZoneEnablers
means any positive rule
evaluation across the enablers result in an effective SpeedZone.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSpeedZoneEnablerRules()
Tests if this user can perform lookups of speed zone enabler/speed
zone mappings.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
IdList |
getSpeedZoneEnablerIdsForSpeedZone(Id speedZoneId)
Gets the
SpeedZoneEnabler Id associated with a
SpeedZone. |
SpeedZoneEnablerList |
getSpeedZoneEnablersForSpeedZone(Id speedZoneId)
Gets the
SpeedZoneEnablers associated with a
SpeedZone. |
IdList |
getSpeedZoneIdsForSpeedZoneEnabler(Id speedZoneEnablerId)
Gets the
SpeedZone Ids mapped to a
SpeedZoneEnabler. |
SpeedZoneList |
getSpeedZonesForSpeedZoneEnabler(Id speedZoneEnablerId)
Gets the
SpeedZones mapped to a
SpeedZoneEnabler. |
void |
useComparativeSpeedZoneEnablerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
void |
usePlenarySpeedZoneEnablerRuleView()
A complete view of the
SpeedZoneEnabler and
SpeedZone returns is desired. |
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 canLookupSpeedZoneEnablerRules()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeSpeedZoneEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenarySpeedZoneEnablerRuleView()
SpeedZoneEnabler
and
SpeedZone
returns is desired. Methods will return what is
requested or result in an error. This view is used when greater
precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. void useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. IdList getSpeedZoneEnablerIdsForSpeedZone(Id speedZoneId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZoneEnabler Id
associated with a
SpeedZone.
speedZoneId
- Id
of the SpeedZone
Ids
NotFoundException
- speedZoneId
is not
foundNullArgumentException
- speedZoneId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneEnablerList getSpeedZoneEnablersForSpeedZone(Id speedZoneId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZoneEnablers
associated with a
SpeedZone.
speedZoneId
- Id
of the SpeedZone
NotFoundException
- speedZoneId
is not
foundNullArgumentException
- speedZoneId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSpeedZoneIdsForSpeedZoneEnabler(Id speedZoneEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZone
Ids
mapped to a
SpeedZoneEnabler.
speedZoneEnablerId
- Id
of a
SpeedZoneEnabler
Ids
NotFoundException
- speedZoneEnablerId
is not foundNullArgumentException
- speedZoneEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneList getSpeedZonesForSpeedZoneEnabler(Id speedZoneEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZones
mapped to a
SpeedZoneEnabler.
speedZoneEnablerId
- Id
of a
SpeedZoneEnabler
NotFoundException
- speedZoneEnablerId
is not foundNullArgumentException
- speedZoneEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.