OSID - osid.control.SettingNotificationSession Service Interface Definition

Interface	osid.control.SettingNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Setting` 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 `SettingLookupSession.`
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	canRegisterForSettingNotifications
Description	Tests if this user can register for `Setting` 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 settings 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	reliableSettingNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeSettingNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableSettingNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeSettingNotification
Description	Acknowledge a setting 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	registerForNewSettings
Description	Register for notifications of new settings. `SettingReceiver.newSettings()` is invoked when a new `Setting` appears in this system.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewSettingsForController
Description	Register for notifications of new settings for the given controller. `SettingReceiver.newSettings()` is invoked when a new `Setting` appears in 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.
Method	registerForChangedSettings
Description	Registers for notification of updated settings. `SettingReceiver.changedSettings()` is invoked when a setting 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	registerForChangedSettingsForController
Description	Registers for notification of updated settings for the given controller. `SettingReceiver.changedSettings()` is invoked when a setting 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	registerForChangedSetting
Description	Registers for notification of an updated setting. `SettingReceiver.changedSettings()` is invoked when the specified setting in this system is changed.
Parameters	`osid.id.Id`	`settingId`	the `Id` of the `Setting` to monitor
Errors	NULL_ARGUMENT		`settingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedSettings
Description	Registers for notification of deleted settings. `SettingReceiver.deletedSettings()` is invoked when a setting 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	registerForDeletedSettingsForController
Description	Registers for notification of deleted settings for the given controller. `SettingReceiver.deletedSettings()` is invoked when a setting 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.
Method	registerForDeletedSetting
Description	Registers for notification of a deleted setting. `SettingReceiver.deletedSettings()` is invoked when the specified setting is deleted or removed from this system.
Parameters	`osid.id.Id`	`settingId`	the `Id` of the `Setting` to monitor
Errors	NULL_ARGUMENT		`settingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.