OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SettingNotificationSession
Implementsosid.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.

MethodgetSystemId
Description

Gets the System Id associated with this session.

Returnosid.id.Idthe System Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSystem
Description

Gets the System associated with this session.

Returnosid.control.Systemthe system
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForSettingNotifications
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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedSystemView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedSystemView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this system only.

CompliancemandatoryThis method is must be implemented.
MethodreliableSettingNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeSettingNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableSettingNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeSettingNotification
Description

Acknowledge a setting notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewSettings
Description

Register for notifications of new settings. SettingReceiver.newSettings() is invoked when a new Setting appears in this system.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewSettingsForController
Description

Register for notifications of new settings for the given controller. SettingReceiver.newSettings() is invoked when a new Setting appears in this system.

Parametersosid.id.IdcontrollerIdthe Id of the controller to monitor
ErrorsNULL_ARGUMENT controllerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedSettings
Description

Registers for notification of updated settings. SettingReceiver.changedSettings() is invoked when a setting in this system is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedSettingsForController
Description

Registers for notification of updated settings for the given controller. SettingReceiver.changedSettings() is invoked when a setting in this system is changed.

Parametersosid.id.IdcontrollerIdthe Id of the controller to monitor
ErrorsNULL_ARGUMENT controllerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedSetting
Description

Registers for notification of an updated setting. SettingReceiver.changedSettings() is invoked when the specified setting in this system is changed.

Parametersosid.id.IdsettingIdthe Id of the Setting to monitor
ErrorsNULL_ARGUMENT settingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedSettings
Description

Registers for notification of deleted settings. SettingReceiver.deletedSettings() is invoked when a setting is deleted or removed from this system.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedSettingsForController
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.

Parametersosid.id.IdcontrollerIdthe Id of the controller to monitor
ErrorsNULL_ARGUMENT controllerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedSetting
Description

Registers for notification of a deleted setting. SettingReceiver.deletedSettings() is invoked when the specified setting is deleted or removed from this system.

Parametersosid.id.IdsettingIdthe Id of the Setting to monitor
ErrorsNULL_ARGUMENT settingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.