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

This session defines methods to receive notifications on adds/changes to resources on routes in this Map. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

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

Tests if this user can register for notifications. 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 opt not to offer notification operations.

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

Federates the view for methods in this session. A federated view will include locations 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 notifications to this map only.

CompliancemandatoryThis method is must be implemented.
MethodreliableResourceRouteNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeResourceRouteNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableResourceRouteNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeResourceRouteNotification
Description

Acknowledge a resource route notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForStartedRoutes
Description

Register for notifications of new routes for a resource. ResourceRouteReceiver.startedRoute() is invoked when a resource begins a route.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForStartedRoute
Description

Register for notifications of a started route. ResourceRouteReceiver.startedRoute() is invoked when a resource begins the specified route.

Parametersosid.id.IdrouteIdthe Id of the Route to monitor
ErrorsNULL_ARGUMENT routeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForStartedRoutesByStartingLocation
Description

Register for notifications of a started route from the specified location. ResourceRouteReceiver.startedRoute() is invoked when the specified resource begins a route.

Parametersosid.id.IdlocationIdthe Id of the Location to monitor
ErrorsNULL_ARGUMENT locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForStartedRoutesByEndingLocation
Description

Register for notifications of a started route to the specified location. ResourceRouteReceiver.startedRoute() is invoked when the specified resource begins a route.

Parametersosid.id.IdlocationIdthe Id of the Location to monitor
ErrorsNULL_ARGUMENT locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForStartedRoutesForResource
Description

Register for notifications of a started route for the given resource. ResourceRouteReceiver.startedRoute() is invoked when the specified resource begins a route.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForStartedRoutesForResourcesByGenusType
Description

Register for notifications of a started route for resources of the given resource genus type. ResourceRouteReceiver.startedRoute() is invoked when the specified resource begins a route.

Parametersosid.type.TyperesourceGenusTypethe genus type of the Resource to monitor
ErrorsNULL_ARGUMENT resourceGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCompletedRoutes
Description

Registers for notification of completed routes. ResourceRouteReceiver.completedRoute() is invoked when a resource completes a route.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCompletedRoute
Description

Register for notifications of a completed route. ResourceRouteReceiver.completedRoute() is invoked when a resource completes the specified route.

Parametersosid.id.IdrouteIdthe Id of the Route to monitor
ErrorsNULL_ARGUMENT routeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCompletedRoutesByStartingLocation
Description

Registers for notification of a completed route from the specified starting location. ResourceRouteReceiver.completedRoute() is invoked when the specified resource completes a route.

Parametersosid.id.IdlocationIdthe Id of the Location to monitor
ErrorsNULL_ARGUMENT locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCompletedRoutesByEndingLocation
Description

Registers for notification of a completed route from the specified ending location. ResourceRouteReceiver.completedRoute() is invoked when the specified resource completes a route.

Parametersosid.id.IdlocationIdthe Id of the Location to monitor
ErrorsNULL_ARGUMENT locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCompletedRoutesForResource
Description

Registers for notification of a completed route for the given resource. ResourceRouteReceiver.completedRoute() is invoked when the specified resource completes a route.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCompletedRoutesForResourcesByGenusType
Description

Registers for notification of a completed route for resources of the given resource genus type. ResourceRouteReceiver.completedRoute() is invoked when the specified resource completes a route.

Parametersosid.type.TyperesourceGenusTypethe genus type of the Resource to monitor
ErrorsNULL_ARGUMENT resourceGenusTYpe is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCancelledRoutes
Description

Registers for notification of cancelled routes. ResourceRouteReceiver.cancelledRoute() is invoked when a resource cancels a route.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCancelledRoute
Description

Register for notifications of a cancelled route. ResourceRouteReceiver.completedRoute() is invoked when a resource cancels the specified route.

Parametersosid.id.IdrouteIdthe Id of the Route to monitor
ErrorsNULL_ARGUMENT routeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCancelledRoutesByStartingLocation
Description

Registers for notification of cancelled routes from the specified starting location. ResourceRouteReceiver.cancelledRoute() is invoked when a specified resource cancels a route.

Parametersosid.id.IdlocationIdthe Id of the Location to monitor
ErrorsNULL_ARGUMENT locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCancelledRoutesByEndingLocation
Description

Registers for notification of cancelled routes from the specified ending location. ResourceRouteReceiver.cancelledRoute() is invoked when a specified resource cancels a route.

Parametersosid.id.IdlocationIdthe Id of the Location to monitor
ErrorsNULL_ARGUMENT locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCancelledRoutesForResource
Description

Registers for notification of cancelled routes for the given resource. ResourceRouteReceiver.cancelledRoute() is invoked when a specified resource cancels a route.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForCancelledRoutesForResourcesByGenusType
Description

Registers for notification of cancelled routes for resources of the given resource genus type. ResourceRouteReceiver.cancelledRoute() is invoked when a specified resource cancels a route.

Parametersosid.type.TyperesourceGenusTypethe genus type of the Resource to monitor
ErrorsNULL_ARGUMENT resourceGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewRouteSegments
Description

Registers for notification of new route segments. ResourceRouteReceiver.newRouteSegment() is invoked when a resource moves on to a new route segment.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewRouteSegment
Description

Registers for notification of new route segments. ResourceRouteReceiver.newRouteSegment() is invoked when a resource moves on to the desigtnated route segment.

Parametersosid.id.IdrouteSegmentIdthe Id of the RouteSegment to monitor
ErrorsNULL_ARGUMENT routeSegmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewRouteSegmentsForResource
Description

Registers for notification of new route segments for the given resource. ResourceRouteReceiver.newRouteSegment() is invoked when the specified resource moves on to a new route segment.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewRouteSegmentsForResourcesByGenusType
Description

Registers for notification of new route segments for resources of the given genus type. ResourceRouteReceiver.newRouteSegment() is invoked when the specified resource moves on to a new route segment.

Parametersosid.type.TyperesourceGenusTypethe genus type of the Resource to monitor
ErrorsNULL_ARGUMENT resourceGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.