public interface SpeedZoneLookupSession extends OsidSession
This session defines methods for retrieving speed zones.
This lookup session defines several views:
SpeedZones
with the SpeedZoneAdminSession.
The methods useFederatedMapView()
and
useIsolatedMapView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Speed zones may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the SpeedZones.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSpeedZones()
Tests if this user can perform
SpeedZone lookups. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
SpeedZone |
getSpeedZone(Id speedZoneId)
Gets the
SpeedZone specified by its Id. |
SpeedZoneList |
getSpeedZones()
Gets all
SpeedZones. |
SpeedZoneList |
getSpeedZonesByGenusType(Type speedZoneGenusType)
Gets a
SpeedZoneList corresponding to the given speed
zone genus Type which does not include speed zones of
types derived from the specified Type. |
SpeedZoneList |
getSpeedZonesByIds(IdList speedZoneIds)
Gets a
SpeedZoneList corresponding to the given
IdList. |
SpeedZoneList |
getSpeedZonesByParentGenusType(Type speedZoneGenusType)
Gets a
SpeedZoneList corresponding to the given speed
zone genus Type and include any additional speed zones
with genus types derived from the specified Type. |
SpeedZoneList |
getSpeedZonesByRecordType(Type speedZoneRecordType)
Gets a
SpeedZoneList containing the given speed zone
record Type. |
SpeedZoneList |
getSpeedZonesForPath(Id pathId)
Gets a
SpeedZoneList containing the given path. |
SpeedZoneList |
getSpeedZonesForPathAtCoordinate(Id pathId,
Coordinate coordinate,
Distance distance)
Gets a
SpeedZoneList containing the given path between
the given coordinates inclusive. |
void |
useActiveSpeedZoneView()
Only active speed zones are returned by methods in this session.
|
void |
useAnyStatusSpeedZoneView()
All active and inactive speed zones are returned by methods in this
session.
|
void |
useComparativeSpeedZoneView()
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 |
usePlenarySpeedZoneView()
A complete view of the
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 canLookupSpeedZones()
SpeedZone
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 lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeSpeedZoneView()
mandatory
- This method is must be implemented. void usePlenarySpeedZoneView()
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. void useActiveSpeedZoneView()
mandatory
- This method is must be implemented. void useAnyStatusSpeedZoneView()
mandatory
- This method is must be implemented. SpeedZone getSpeedZone(Id speedZoneId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZone
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
SpeedZone
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a SpeedZone
and retained for compatibility.
In active mode, speed zones are returned that are currently active. In
any status mode, active and inactive speed zones are returned.speedZoneId
- the Id
of the SpeedZone
to retrieve SpeedZone
NotFoundException
- no SpeedZone
found
with the given Id
NullArgumentException
- speedZoneId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneList getSpeedZonesByIds(IdList speedZoneIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZoneList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
speed zones specified in the Id
list, in the order of
the list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible SpeedZones
may be omitted from the list
and may present the elements in any order including returning a unique
set.
In active mode, speed zones are returned that are currently active. In
any status mode, active and inactive speed zones are returned.speedZoneIds
- the list of Ids
to retrieve SpeedZone
listNotFoundException
- an Id was
not foundNullArgumentException
- speedZoneIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneList getSpeedZonesByGenusType(Type speedZoneGenusType) throws OperationFailedException, PermissionDeniedException
SpeedZoneList
corresponding to the given speed
zone genus Type
which does not include speed zones of
types derived from the specified Type.
In plenary mode, the returned list contains all known
speed zones or an error results. Otherwise, the returned list may
contain only those speed zones that are accessible through this
session.
In active mode, speed zones are returned that are currently active. In
any status mode, active and inactive speed zones are returned.speedZoneGenusType
- a speed zone genus type SpeedZone
listNullArgumentException
- speedZoneGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneList getSpeedZonesByParentGenusType(Type speedZoneGenusType) throws OperationFailedException, PermissionDeniedException
SpeedZoneList
corresponding to the given speed
zone genus Type
and include any additional speed zones
with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
speed zones or an error results. Otherwise, the returned list may
contain only those speed zones that are accessible through this
session.
In active mode, speed zones are returned that are currently active. In
any status mode, active and inactive speed zones are returned.speedZoneGenusType
- a speed zone genus type SpeedZone
listNullArgumentException
- speedZoneGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneList getSpeedZonesByRecordType(Type speedZoneRecordType) throws OperationFailedException, PermissionDeniedException
SpeedZoneList
containing the given speed zone
record Type.
In plenary mode, the returned list contains all known speed zones or
an error results. Otherwise, the returned list may contain only those
speed zones that are accessible through this session.
In active mode, speed zones are returned that are currently active. In
any status mode, active and inactive speed zones are returned.speedZoneRecordType
- a speed zone record type SpeedZone
listNullArgumentException
- speedZoneRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneList getSpeedZonesForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
SpeedZoneList
containing the given path.
In plenary mode, the returned list contains all known spwed zones or
an error results. Otherwise, the returned list may contain only those
speed zones that are accessible through this session.
In active mode, speed zones are returned that are currently active. In
any status mode, active and inactive speed zones are returned.pathId
- a path Id
SpeedZone
listNullArgumentException
- pathId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneList getSpeedZonesForPathAtCoordinate(Id pathId, Coordinate coordinate, Distance distance) throws OperationFailedException, PermissionDeniedException
SpeedZoneList
containing the given path between
the given coordinates inclusive.
In plenary mode, the returned list contains all known speed zones or
an error results. Otherwise, the returned list may contain only those
speed zones that are accessible through this session.
In active mode, speed zones are returned that are currently active. In
any status mode, active and inactive speed zones are returned.pathId
- a path Id
coordinate
- starting coordinatedistance
- a distance from coordinate SpeedZone
listNullArgumentException
- pathId, coordinate
or distance
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneList getSpeedZones() throws OperationFailedException, PermissionDeniedException
SpeedZones.
In plenary mode, the returned list contains all known speed zones or
an error results. Otherwise, the returned list may contain only those
speed zones that are accessible through this session.
In active mode, speed zones are returned that are currently active. In
any status mode, active and inactive speed zones are returned. SpeedZones
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.