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

Interface	osid.mapping.path.ResourceSignalNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications for signal crossings 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	canRegisterForResourceSignalNotifications
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 signals 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	registerForSignals
Description	Register for notifications of resources passing signals. `ResourceSignalReceiver.crossedSignal()` is invoked when a resource crosses a signal.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForCrossedSignal
Description	Register for notifications of resources crossing a given signal. `ResourceSignalReceiver.crossedSignal()` is invoked when a resource crosses the designated signal.
Parameters	`osid.id.Id`	`signalId`	the `Id` of the `Signal` to monitor
Errors	NULL_ARGUMENT		`signalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForCrossedSignalsForResource
Description	Register for notifications of resources crossing signals. `ResourcePathReceiver.crossedSignal()` is invoked when the specified resource crosses a signal.
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	registerForCrossedSignalsForResourcesByGenusType
Description	Register for notifications of resources crossing signals for resources of the given genus type. `ResourcePathReceiver.crossedSignal()` is invoked when the specified resource crosses a signal.
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	registerForCrossedSignalsByPath
Description	Register for notifications of resources crossing signals on the given path. `ResourcePathReceiver.crossedSignal()` is invoked when the specified resource crosses a signal.
Parameters	`osid.id.Id`	`pathId`	the `Id` of the `Path` to monitor
Errors	NULL_ARGUMENT		`pathId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.