OSID - osid.mapping.path.ResourceVelocityNotificationSession Service Interface Definition

Interface	osid.mapping.path.ResourceVelocityNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.MappingPathManager`
Used By	`osid.mapping.path.MappingPathProxyManager`
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.
Method	getMapId
Description	Gets the `Map` `Id` associated with this session.
Return	`osid.id.Id`		the `Map Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMap
Description	Gets the `Map` associated with this session.
Return	`osid.mapping.Map`		the map
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForResourcePathNotifications
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.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedMapView
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.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedMapView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this map only.
Compliance	`mandatory`		This method is must be implemented.
Method	registerForMovingResources
Description	Registers for notification of moved resources. `ResourceVelocityReceiver.movingResource()` is invoked when a resource begins to move.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForMovingResource
Description	Registers for notification of moved resources. `ResourceVelocityReceiver.movingResource()` is invoked when the specified resource begins to move.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForMovingResourcesByGenusType
Description	Registers for notification of moved resources for the given resource genus type. `ResourceVelocityReceiver.movingResource()` is invoked when a resource begins to move.
Parameters	`osid.type.Type`	`resourceGenusType`	the genus type of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStoppedResources
Description	Registers for notification of stopped resources. `ResourceVelocityReceiver.stoppedResource()` is invoked when a resource stops moving.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStoppedResource
Description	Registers for notification of stopped resources. `ResourceVelocityReceiver.stoppedResource()` is invoked when the specified resource stops moving.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStoppedResourcesByGenusType
Description	Registers for notification of stopped resources for the given resource genus type. `ResourceVelocityReceiver.stoppedResource()` is invoked when a resource stops moving.
Parameters	`osid.type.Type`	`resourceGenusType`	the genus type of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedResourceVelocities
Description	Registers for notification of changed resource velocities. `ResourceRouteReceiver.changedResourceVelcoity()` is invoked when a resource changes speed or direction.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerFoChangedResourceVelocity
Description	Registers for notification of moving resources. `ResourceRouteReceiver.changedResourceVelocityResource()` is invoked when the specified resource changes speed or direction.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedResourceVelocitiesByGenusType
Description	Registers for notification of moving resources for the given resource genus type. `ResourceRouteReceiver.changedResourceVelocity()` is invoked when a resource changes speed or direction.
Parameters	`osid.type.Type`	`resourceGenusType`	the genus type of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.