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

Interface	osid.mapping.path.SignalNotificationSession
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 `Signal` objects in this `Map`. This also includes existing signals that may appear or disappear due to changes in the `Signal` hierarchy, 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. The two views defined in this session correspond to the views in the `SignalLookupSession`.
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	canRegisterForSignalNotifications
Description	Tests if this user can register for `Signal` 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.
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	acknowledgeSignalNotification
Description	Acknowledge a signal notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewSignals
Description	Register for notifications of new signals. `SignalReceiver.newSignals()` is invoked when a new `Signal` appears in this map.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewSignalsForPath
Description	Registers for notification of new signals for the given path. `SignalReceiver.newSignals()` is invoked when a signal appears in this map.
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.
Method	registerForChangedSignals
Description	Registers for notification of updated signals. `SignalReceiver.changedSignals()` is invoked when a signal in this map is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSignalsForPath
Description	Registers for notification of updated signals for the given path. `SignalReceiver.changedSignals()` is invoked when a signal in this map is changed.
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.
Method	registerForChangedSignal
Description	Registers for notification of an updated signal. `SignalReceiver.changedSignals()` is invoked when the specified signal in this map is changed.
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	registerForDeletedSignals
Description	Registers for notification of deleted signals. `SignalReceiver.deletedSignals()` is invoked when a signal is deleted or removed from this map.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedSignal
Description	Registers for notification of a deleted signal. `SignalReceiver.deletedSignals()` is invoked when the specified signal is deleted or removed from this map.
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	registerForDeletedSignalsForPath
Description	Registers for notification of deleted signals for the given path. `SignalReceiver.deletedSignals()` is invoked when a signal is deleted or removed from this map.
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.