OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ConfigurationNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Configurations. Notrifications related to adding or removing of parameters are handled through the ValueNotificationSession. This session is intended for adapters and providers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

MethodcanRegisterForConfigurationNotifications
Description

Tests if this user can register for Configuration 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.
MethodreliableConfigurationNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableConfigurationNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeConfigurationNotification
Description

Acknowledge a configuration notification.

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

Registers for notifications of new configurations. ConfigurationReceiver.newConfigurations() is invoked when a new Configuration is created.

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

Registers for notification of updated configurations. ConfigurationReceiver.changedConfigurations() is invoked when a configuration is changed.

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

Registers for notifications of an update to a configuration. ConfigurationReceiver.changedConfigurations() is invoked when the specified Configuration is changed.

Parametersosid.id.IdconfigurationIdthe Id of the Configuration to monitor
ErrorsNOT_FOUNDa Configuration was not found identified by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedConfigurations
Description

Registers for notification of deleted configurations. ConfigurationReceiver.deletedConfigurations() is invoked when a Configuration is deleted.

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

Registers for notifications of a deleted configuration. ConfiguratinReceiver.deletedConfigurations() is invoked when the specified configuration is deleted.

Parametersosid.id.IdconfigurationIdthe Id of the Configuration to monitor
ErrorsNOT_FOUNDa Configuration was not found identified by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedConfigurationHierarchy
Description

Registers for notification of an updated configuration hierarchy structure. ConfigurationReceiver.changedChildOfConfigurations() is invoked when a node experiences a change in its children.

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

Registers for notification of an updated configuration hierarchy structure. ConfigurationReceiver.changedChildOfConfigurations() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdconfigurationIdthe Id of the Configuration node to monitor
ErrorsNULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedConfigurationHierarchyForDescendants
Description

Registers for notification of an updated configuration hierarchy structure. ConfigurationReceiver.changedChildOfConfigurations() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdconfigurationIdthe Id of the Configuration node to monitor
ErrorsNULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.