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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RouteQuery can be retrieved from this session and mapped to this Map to create a virtual collection of Routes. The routes may be sequenced using the RouteSearchOrder from this session.

This Map has a default query that matches any route and a default search order that specifies no sequencing. The queries may be examined using a RouteQueryInspector. The query may be modified by converting the inspector back to a RouteQuery.

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

Tests if this user can manage smart maps. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart map management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRouteQuery
Description

Gets a route query.

Returnosid.mapping.route.RouteQuerythe route query
CompliancemandatoryThis method must be implemented.
MethodgetRouteSearchOrder
Description

Gets a route search order.

Returnosid.mapping.route.RouteSearchOrderthe route search order
CompliancemandatoryThis method must be implemented.
MethodapplyRouteQuery
Description

Applies a route query to this map.

Parametersosid.mapping.route.RouteQueryrouteQuerythe route query
ErrorsNULL_ARGUMENT routeQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED routeQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectRouteQuery
Description

Gets a route query inspector for this map.

Returnosid.mapping.route.RouteQueryInspectorthe route query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyRouteSequencing
Description

Applies a route search order to this map.

Parametersosid.mapping.route.RouteSearchOrderrouteSearchOrderthe route search order
ErrorsNULL_ARGUMENT routeSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED routeSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRouteQueryFromInspector
Description

Gets a route query from an inspector.

Parametersosid.mapping.route.RouteQueryInspectorrouteQueryInspectora route query inspector
Returnosid.mapping.route.RouteQuerythe route query
ErrorsNULL_ARGUMENT routeQueryInspector is null
UNSUPPORTED routeQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.