Interface SpeedZoneMapSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SpeedZoneMapSession
extends OsidSession

This session provides methods to retrieve SpeedZone to Map speed zones. A SpeedZone may appear in multiple Map objects. Each map may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupSpeedZoneMapSpeedZones()	Tests if this user can perform lookups of speed zone/map speed zones.
IdList	getMapIdsBySpeedZone(Id speedZoneId)	Gets the Map Ids mapped to a SpeedZone .
MapList	getMapsBySpeedZone(Id speedZoneId)	Gets the Maps mapped to a SpeedZone .
IdList	getSpeedZoneIdsByMap(Id mapId)	Gets the list of SpeedZone Ids associated with a Map .
IdList	getSpeedZoneIdsByMaps(IdList mapIds)	Gets the list of SpeedZone Ids corresponding to a list of Maps .
SpeedZoneList	getSpeedZonesByMap(Id mapId)	Gets the list of SpeedZones associated with a Map .
SpeedZoneList	getSpeedZonesByMaps(IdList mapIds)	Gets the list of SpeedZones corresponding to a list of Maps .
void	useComparativeSpeedZoneMapView()	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	usePlenarySpeedZoneMapView()	A complete view of the SpeedZone and Map returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupSpeedZoneMapSpeedZones

boolean canLookupSpeedZoneMapSpeedZones()

Tests if this user can perform lookups of speed zone/map speed zones. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up speed zones is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeSpeedZoneMapView

void useComparativeSpeedZoneMapView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenarySpeedZoneMapView

void usePlenarySpeedZoneMapView()

A complete view of the SpeedZone and Map 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.

Compliance:

mandatory - This method is must be implemented.

getSpeedZoneIdsByMap

IdList getSpeedZoneIdsByMap(Id mapId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of SpeedZone Ids associated with a Map .

Parameters:

mapId - Id of the Map

Returns:

list of related speed zone Ids

Throws:

NotFoundException - mapId is not found

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZonesByMap

SpeedZoneList getSpeedZonesByMap(Id mapId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of SpeedZones associated with a Map .

Parameters:

mapId - Id of the Map

Returns:

list of related speed zones

Throws:

NotFoundException - mapId is not found

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZoneIdsByMaps

IdList getSpeedZoneIdsByMaps(IdList mapIds)
                      throws OperationFailedException,
PermissionDeniedException

Gets the list of SpeedZone Ids corresponding to a list of Maps .

Parameters:

mapIds - list of map Ids

Returns:

list of speed zone Ids

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZonesByMaps

SpeedZoneList getSpeedZonesByMaps(IdList mapIds)
                           throws OperationFailedException,
PermissionDeniedException

Gets the list of SpeedZones corresponding to a list of Maps .

Parameters:

mapIds - list of map Ids

Returns:

list of speed zones

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapIdsBySpeedZone

IdList getMapIdsBySpeedZone(Id speedZoneId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Map Ids mapped to a SpeedZone .

Parameters:

speedZoneId - Id of a SpeedZone

Returns:

list of maps

Throws:

NotFoundException - speedZoneId is not found

NullArgumentException - speedZoneId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapsBySpeedZone

MapList getMapsBySpeedZone(Id speedZoneId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Maps mapped to a SpeedZone .

Parameters:

speedZoneId - Id of a SpeedZone

Returns:

list of maps

Throws:

NotFoundException - speedZoneId is not found

NullArgumentException - speedZoneId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.