OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.SpeedZoneLookupSession
Implementsosid.OsidSession
Description

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.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Idthe Map Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Mapthe map
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupSpeedZones
Description

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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeSpeedZoneView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenarySpeedZoneView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedMapView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedMapView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseActiveSpeedZoneView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusSpeedZoneView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetSpeedZone
Description

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.

Parametersosid.id.IdspeedZoneIdthe Id of the SpeedZone to retrieve
Returnosid.mapping.path.SpeedZonethe returned SpeedZone
ErrorsNOT_FOUNDno SpeedZone found with the given Id
NULL_ARGUMENT speedZoneId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZonesByIds
Description

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.

Parametersosid.id.IdListspeedZoneIdsthe list of Ids to retrieve
Returnosid.mapping.path.SpeedZoneListthe returned SpeedZone list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT speedZoneIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZonesByGenusType
Description

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.

Parametersosid.type.TypespeedZoneGenusTypea speed zone genus type
Returnosid.mapping.path.SpeedZoneListthe returned SpeedZone list
ErrorsNULL_ARGUMENT speedZoneGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZonesByParentGenusType
Description

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.

Parametersosid.type.TypespeedZoneGenusTypea speed zone genus type
Returnosid.mapping.path.SpeedZoneListthe returned SpeedZone list
ErrorsNULL_ARGUMENT speedZoneGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZonesByRecordType
Description

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.

Parametersosid.type.TypespeedZoneRecordTypea speed zone record type
Returnosid.mapping.path.SpeedZoneListthe returned SpeedZone list
ErrorsNULL_ARGUMENT speedZoneRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZonesForPath
Description

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.

Parametersosid.id.IdpathIda path Id
Returnosid.mapping.path.SpeedZoneListthe returned SpeedZone list
ErrorsNULL_ARGUMENT pathId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZonesForPathAtCoordinate
Description

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.

Parametersosid.id.IdpathIda path Id
osid.mapping.Coordinatecoordinatestarting coordinate
osid.mapping.Distancedistancea distance from coordinate
Returnosid.mapping.path.SpeedZoneListthe returned SpeedZone list
ErrorsNULL_ARGUMENT pathId, coordinate or distance is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZones
Description

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.

Returnosid.mapping.path.SpeedZoneLista list of SpeedZones
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.