OSID - osid.control.ControllerNotificationSession Service Interface Definition

Interface	osid.control.ControllerNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.control.ControlManager`
Used By	`osid.control.ControlProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Controllers` in this `System`. This also includes existing controllers that may appear or disappear due to changes in the `System` 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 `ControllerLookupSession`.
Method	getSystemId
Description	Gets the `System` `Id` associated with this session.
Return	`osid.id.Id`		the `System Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getSystem
Description	Gets the `System` associated with this session.
Return	`osid.control.System`		the system
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForControllerNotifications
Description	Tests if this user can register for `Controller` 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	useFederatedSystemView
Description	Federates the view for methods in this session. A federated view will include controllers in systems which are children of this system in the system hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedSystemView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this system only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableControllerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeControllerNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableControllerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeControllerNotification
Description	Acknowledge a controller 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	registerForNewControllers
Description	Register for notifications of new controllers. `ControllerReceiver.newControllers()` is invoked when a new `Controller` appears in this system.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedControllers
Description	Registers for notification of updated controllers. `ControllerReceiver.changedControllers()` is invoked when a controller in this system is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedController
Description	Registers for notification of an updated controller. `SceneReceiver.changedControllers()` is invoked when the specified controller in this system is changed.
Parameters	`osid.id.Id`	`controllerId`	the `Id` of the `Controller` to monitor
Errors	NULL_ARGUMENT		`controllerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedControllers
Description	Registers for notification of deleted controllers. `ControllerReceiver.deletedControllers()` is invoked when a controller is deleted or removed from this system.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedController
Description	Registers for notification of a deleted controller. `ControllerReceiver.deletedControllers()` is invoked when the specified controller is deleted or removed from this system.
Parameters	`osid.id.Id`	`controllerId`	the `Id` of the `Controller` to monitor
Errors	NULL_ARGUMENT		`controllerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.