org.osid.mapping.path

Interface SpeedZoneLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface SpeedZoneLookupSession
extends OsidSession

This session defines methods for retrieving speed zones.

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
• isolated map view: All speed zone methods in this session operate, retrieve and pertain to speed zones defined explicitly in the current map. Using an isolated view is useful for managing SpeedZones with the SpeedZoneAdminSession.
• federated map view: All speed zone lookup methods in this session operate, retrieve and pertain to all speed zones defined in this map and any other speed zones implicitly available in this map through map inheritence.
• active speed zone view: All speed zone lookup methods return active speed zones.
• any status speed zone view: Speed zones of any active or inactive status are returned from methods.

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getMapId

Id getMapId()

Gets the Map Id associated with this session.

Returns:

the Map Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMap

Map getMap()
           throws OperationFailedException,
                  PermissionDeniedException

Gets the Map associated with this session.

Returns:

the map

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupSpeedZones

boolean canLookupSpeedZones()

Tests if this user can perform 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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeSpeedZoneView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenarySpeedZoneView

void usePlenarySpeedZoneView()

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

Compliance:

mandatory - This method is must be implemented.

useFederatedMapView

void useFederatedMapView()

Federates the view for methods in this session. A federated view will include speed zones in maps which are children of this map in the map hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedMapView

void useIsolatedMapView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this map only.

Compliance:

mandatory - This method is must be implemented.

useActiveSpeedZoneView

void useActiveSpeedZoneView()

Only active speed zones are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusSpeedZoneView

void useAnyStatusSpeedZoneView()

All active and inactive speed zones are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getSpeedZone

SpeedZone getSpeedZone(Id speedZoneId)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Gets the 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.

Parameters:

speedZoneId - the Id of the SpeedZone to retrieve

Returns:

the returned SpeedZone

Throws:

NotFoundException - no SpeedZone found with the given Id

NullArgumentException - speedZoneId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZonesByIds

SpeedZoneList getSpeedZonesByIds(IdList speedZoneIds)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets a 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.

Parameters:

speedZoneIds - the list of Ids to retrieve

Returns:

the returned SpeedZone list

Throws:

NotFoundException - an Id was not found

NullArgumentException - speedZoneIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZonesByGenusType

SpeedZoneList getSpeedZonesByGenusType(Type speedZoneGenusType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a 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.

Parameters:

speedZoneGenusType - a speed zone genus type

Returns:

the returned SpeedZone list

Throws:

NullArgumentException - speedZoneGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZonesByParentGenusType

SpeedZoneList getSpeedZonesByParentGenusType(Type speedZoneGenusType)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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. 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.

Parameters:

speedZoneGenusType - a speed zone genus type

Returns:

the returned SpeedZone list

Throws:

NullArgumentException - speedZoneGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZonesByRecordType

SpeedZoneList getSpeedZonesByRecordType(Type speedZoneRecordType)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets a 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.

Parameters:

speedZoneRecordType - a speed zone record type

Returns:

the returned SpeedZone list

Throws:

NullArgumentException - speedZoneRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZonesForPath

SpeedZoneList getSpeedZonesForPath(Id pathId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets a 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.

Parameters:

pathId - a path Id

Returns:

the returned SpeedZone list

Throws:

NullArgumentException - pathId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZonesForPathAtCoordinate

SpeedZoneList getSpeedZonesForPathAtCoordinate(Id pathId,
                                             Coordinate coordinate,
                                             Distance distance)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Gets a 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.

Parameters:

pathId - a path Id

coordinate - starting coordinate

distance - a distance from coordinate

Returns:

the returned SpeedZone list

Throws:

NullArgumentException - pathId, coordinate or distance is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZones

SpeedZoneList getSpeedZones()
                            throws OperationFailedException,
                                   PermissionDeniedException

Gets all 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.

Returns:

a list of SpeedZones

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.