OSID Logo
OSID Specifications
mapping route package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.route.RouteMapSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Route to Map mappings. A Route 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
MethodcanLookupRouteMapLocations
Description

Tests if this user can perform lookups of route/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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeRouteMapView
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.
MethodusePlenaryRouteMapView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetRouteIdsByMap
Description

Gets the list of Route Ids associated with a Map.

Parametersosid.id.IdmapId Id of the Map
Returnosid.id.IdListlist of related route Ids
ErrorsNOT_FOUND mapId is not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRoutesByMap
Description

Gets the list of Routes associated with a Map.

Parametersosid.id.IdmapId Id of the Map
Returnosid.mapping.route.RouteListlist of related routes
ErrorsNOT_FOUND mapId is not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRouteIdsByMaps
Description

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

Parametersosid.id.IdListmapIdslist of map Ids
Returnosid.id.IdListlist of route Ids
ErrorsNULL_ARGUMENT mapIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRoutesByMaps
Description

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

Parametersosid.id.IdListmapIdslist of map Ids
Returnosid.mapping.route.RouteListlist of routes
ErrorsNULL_ARGUMENT mapIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapIdsByRoute
Description

Gets the Map Ids mapped to a Route.

Parametersosid.id.IdrouteId Id of a Route
Returnosid.id.IdListlist of maps
ErrorsNOT_FOUND routeId is not found
NULL_ARGUMENT routeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapsByRoute
Description

Gets the Maps mapped to a Route.

Parametersosid.id.IdrouteId Id of a Route
Returnosid.mapping.MapListlist of maps
ErrorsNOT_FOUND routeId is not found
NULL_ARGUMENT routeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.