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

This session defines methods to track resources on routes.

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

Tests if this user can access the locations of resources. 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 location operations to unauthorized users.

Returnboolean false if location methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeResourceRouteView
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.
MethodusePlenaryResourceRouteView
Description

A complete view of the Resource 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 paths 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.
MethodisResourceOnARoute
Description

Tests if the resource is traveling along a route.

Parametersosid.id.IdresourceIda resource Id
Returnboolean true if the resource is on a route, false otherrwise
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodgetRouteSegmentForResource
Description

Gets the current route of the given resource.

Parametersosid.id.IdresourceIda resource Id
Returnosid.mapping.route.RouteSegmentthe current route segment
ErrorsILLEGAL_STATE isResourceOnARoute() is false
NOT_FOUND resourceId is not on map
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRouteSegmentsForResources
Description

Gets the current locations of the given resources. In plenary mode, the routes for all the given resources are returned or an error results. In comparative mode, routes may be omitted or reordered.

Parametersosid.id.IdListresourceIdsa resource list
Returnosid.mapping.route.RouteSegmentListthe current route segments
ErrorsNOT_FOUNDa resourceId is not on map
NULL_ARGUMENT resourceIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResourcesOnRoute
Description

Gets the resources along the given route. In plenary mode, all the resources on the route are returned or an error results. In comparative mode, resources may be omitted or reordered.

Parametersosid.id.IdrouteIda route Id
Returnosid.resource.ResourceListthe resources on the route
ErrorsNULL_ARGUMENT routeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResourcesOnRouteSegment
Description

Gets the resources on the given route segment. In plenary mode, all the resources on the route segment are returned or an error results. In comparative mode, resources may be omitted or reordered.

Parametersosid.id.IdrouteSegmentIda route segment Id
Returnosid.resource.ResourceListthe resources on the route segment
ErrorsNULL_ARGUMENT routeSegmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRouteProgressForResource
Description

Gets the route progress for the given resource.

Parametersosid.id.IdresourceIda resource Id
Returnosid.mapping.route.RouteProgressthe current route progress
ErrorsILLEGAL_STATE isResourceOnARoute() is false
NOT_FOUND resourceId is not on map
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRouteProgressForResources
Description

Gets the route progress for the given resources. In plenary mode, the routes for all the given resources are returned or an error results. In comparative mode, routes may be omitted or reordered.

Parametersosid.id.IdListresourceIdsa resource list
Returnosid.mapping.route.RouteProgressListthe current route progress
ErrorsNOT_FOUNDa resourceId is not found
NULL_ARGUMENT resourceIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.