OSID - osid.control.SceneNotificationSession Service Interface Definition

Interface	osid.control.SceneNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Scene` objects in this `dDstributor.` 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 `SceneLookupSession.`
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	canRegisterForSceneNotifications
Description	Tests if this user can register for `Scene` 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 scenes 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	reliableSceneNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeSceneNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableSceneNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeSceneNotification
Description	Acknowledge a scene 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	registerForNewScenes
Description	Register for notifications of new scenes. `SceneReceiver.newScenes()` is invoked when a new `Scene` appears in this system.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedScenes
Description	Registers for notification of updated scenes. `SceneReceiver.changedScenes()` is invoked when a scene 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	registerForChangedScene
Description	Registers for notification of an updated scene. `SceneReceiver.changedScenes()` is invoked when the specified scene in this system is changed.
Parameters	`osid.id.Id`	`sceneId`	the `Id` of the `Scene` to monitor
Errors	NULL_ARGUMENT		`sceneId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedScenes
Description	Registers for notification of deleted scenes. `SceneReceiver.deletedScenes()` is invoked when a scene 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	registerForDeletedScene
Description	Registers for notification of a deleted scene. `SceneReceiver.deletedScenes()` is invoked when the specified scene is deleted or removed from this system.
Parameters	`osid.id.Id`	`sceneId`	the `Id` of the `Scene` to monitor
Errors	NULL_ARGUMENT		`sceneId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.