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

This session defines methods to receive notifications on adds/changes to resource velocities 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.
MethodcanRegisterForResourcePathNotifications
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 wish not to offer notification operations to unauthorized users.

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

Registers for notification of moved resources. ResourceVelocityReceiver.movingResource() is invoked when a resource begins to move.

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

Registers for notification of moved resources. ResourceVelocityReceiver.movingResource() is invoked when the specified resource begins to move.

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

Registers for notification of moved resources for the given resource genus type. ResourceVelocityReceiver.movingResource() is invoked when a resource begins to move.

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

Registers for notification of stopped resources. ResourceVelocityReceiver.stoppedResource() is invoked when a resource stops moving.

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

Registers for notification of stopped resources. ResourceVelocityReceiver.stoppedResource() is invoked when the specified resource stops moving.

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

Registers for notification of stopped resources for the given resource genus type. ResourceVelocityReceiver.stoppedResource() is invoked when a resource stops moving.

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

Registers for notification of changed resource velocities. ResourceRouteReceiver.changedResourceVelcoity() is invoked when a resource changes speed or direction.

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

Registers for notification of moving resources. ResourceRouteReceiver.changedResourceVelocityResource() is invoked when the specified resource changes speed or direction.

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

Registers for notification of moving resources for the given resource genus type. ResourceRouteReceiver.changedResourceVelocity() is invoked when a resource changes speed or direction.

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.