OSID - osid.control.InputNotificationSession Service Interface Definition

Interface	osid.control.InputNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Input` objects in this `System.` This also includes existing inputs 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 `InputLookupSession.`
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	canRegisterForInputNotifications
Description	Tests if this user can register for `Input` 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 inputs 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	reliableInputNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeInputNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableInputNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeInputNotification
Description	Acknowledge an input 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	registerForNewInputs
Description	Register for notifications of new inputs. `InputReceiver.newInputs()` is invoked when a new `Input` appears in this system.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewInputsForDevice
Description	Register for notifications of new inputs for the given device `Id.` `InputReceiver.newInputs()` is invoked when a new `Input` is created.
Parameters	`osid.id.Id`	`deviceId`	the `Id` of the device to monitor
Errors	NULL_ARGUMENT		`deviceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewInputsForController
Description	Register for notifications of new inputs for the given controller `Id.` `InputReceiver.newInputs()` is invoked when a new `Input` is created.
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	registerForChangedInputs
Description	Registers for notification of updated inputs. `InputReceiver.changedInputs()` is invoked when an input 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	registerForChangedInputsForDevice
Description	Register for notifications of updated inputs for the given device `Id.` `InputReceiver.changedInputs()` is invoked when an input in this system is changed.
Parameters	`osid.id.Id`	`deviceId`	the `Id` of the device to monitor
Errors	NULL_ARGUMENT		`deviceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedInputsForController
Description	Register for notifications of updated inputs for the given controller `Id.` `InputReceiver.changedInputs()` is invoked when an input 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	registerForChangedInput
Description	Registers for notification of an updated input. `InputReceiver.changedInput()` is invoked when the specified input in this system is changed.
Parameters	`osid.id.Id`	`inputId`	the `Id` of the `Input` to monitor
Errors	NULL_ARGUMENT		`inputId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedInputs
Description	Registers for notification of deleted inputs. `InputReceiver.deletedInputs()` is invoked when an input 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	registerForDeletedInputsForDevice
Description	Register for notifications of deleted inputs for the given device `Id.` `InputReceiver.deletedInputs()` is invoked when an input in this system is removed or deleted.
Parameters	`osid.id.Id`	`deviceId`	the `Id` of the device to monitor
Errors	NULL_ARGUMENT		`deviceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedInputsForController
Description	Register for notifications of deleted inputs for the given controller `Id.` `InputReceiver.deletedInputs()` is invoked when an input in this system is removed or deleted.
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	registerForDeletedInput
Description	Registers for notification of a deleted input. `InputReceiver.deletedInputs()` is invoked when the specified input is deleted or removed from this system.
Parameters	`osid.id.Id`	`inputId`	the `Id` of the `Input` to monitor
Errors	NULL_ARGUMENT		`inputId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.