Interface SpeedZoneEnablerMapSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SpeedZoneEnablerMapSession
extends OsidSession

This session provides methods to retrieve SpeedZoneEnabler to Map mappings. a SpeedZoneEnabler 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	canLookupSpeedZoneEnablerMapMappings()	Tests if this user can perform lookups of speed zone enabler/map mappings.
IdList	getMapIdsBySpeedZoneEnabler(Id speedZoneEnablerId)	Gets the Map Ids mapped to a SpeedZoneEnabler .
MapList	getMapsBySpeedZoneEnabler(Id speedZoneEnablerId)	Gets the Maps mapped to a SpeedZoneEnabler .
IdList	getSpeedZoneEnablerIdsByMap(Id mapId)	Gets the list of SpeedZoneEnablerIds associated with an Map .
IdList	getSpeedZoneEnablerIdsByMaps(IdList mapIds)	Gets the list of SpeedZoneEnablerIds corresponding to a list of Maps .
SpeedZoneEnablerList	getSpeedZoneEnablersByMap(Id mapId)	Gets the list of speed zone enablers associated with an Map .
SpeedZoneEnablerList	getSpeedZoneEnablersByMaps(IdList mapIds)	Gets the list of speed zone enablers corresponding to a list of Maps .
void	useComparativeSpeedZoneEnablerMapView()	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	usePlenarySpeedZoneEnablerMapView()	A complete view of the SpeedZoneEnabler 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

canLookupSpeedZoneEnablerMapMappings

boolean canLookupSpeedZoneEnablerMapMappings()

Tests if this user can perform lookups of speed zone enabler/map mappings. 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 mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeSpeedZoneEnablerMapView

void useComparativeSpeedZoneEnablerMapView()

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.

usePlenarySpeedZoneEnablerMapView

void usePlenarySpeedZoneEnablerMapView()

A complete view of the SpeedZoneEnabler 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.

getSpeedZoneEnablerIdsByMap

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

Gets the list of SpeedZoneEnablerIds associated with an Map .

Parameters:

mapId - Id of the Map

Returns:

list of related speed zone enabler 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.

getSpeedZoneEnablersByMap

SpeedZoneEnablerList getSpeedZoneEnablersByMap(Id mapId)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of speed zone enablers associated with an Map .

Parameters:

mapId - Id of the Map

Returns:

list of related speed zone enablers

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.

getSpeedZoneEnablerIdsByMaps

IdList getSpeedZoneEnablerIdsByMaps(IdList mapIds)
                             throws OperationFailedException,
PermissionDeniedException

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

Parameters:

mapIds - list of map Ids

Returns:

list of speed zone enabler Ids

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablersByMaps

SpeedZoneEnablerList getSpeedZoneEnablersByMaps(IdList mapIds)
                                         throws OperationFailedException,
PermissionDeniedException

Gets the list of speed zone enablers corresponding to a list of Maps .

Parameters:

mapIds - list of map Ids

Returns:

list of speed zone enablers

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapIdsBySpeedZoneEnabler

IdList getMapIdsBySpeedZoneEnabler(Id speedZoneEnablerId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Map Ids mapped to a SpeedZoneEnabler .

Parameters:

speedZoneEnablerId - Id of a SpeedZoneEnabler

Returns:

list of maps

Throws:

NotFoundException - speedZoneEnablerId is not found

NullArgumentException - speedZoneEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapsBySpeedZoneEnabler

MapList getMapsBySpeedZoneEnabler(Id speedZoneEnablerId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Maps mapped to a SpeedZoneEnabler .

Parameters:

speedZoneEnablerId - Id of a SpeedZoneEnabler

Returns:

list of maps

Throws:

NotFoundException - speedZoneEnablerId is not found

NullArgumentException - speedZoneEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.