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

This session defines methods to receive notifications on changes to Values. A particular value in a set may have been added or deleted, but all changes appear as a change to a parameter. Once a change notification is received, the new value list can be obtained through the ValueLookupSession. 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.

Two views are defined;

  • federated: parameters defined in configurations that are a parent of this configuration in the configuration hierarchy are included for notifications
  • isolated: notifications are restricted to parameters are defined to within this configuration

The methods federateValuerView() and isolateValueView() behave as a radio group and one should be selected before invoking any lookup methods.

MethodgetConfigurationId
Description

Gets the Configuration Id associated with this session.

Returnosid.id.Idthe Configuration Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetConfiguration
Description

Gets the Configuration associated with this session.

Returnosid.configuration.Configurationthe Configuration associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForValueNotifications
Description

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

Federates the view for methods in this session. A federated view will include parameters in configurations of which this configuration is a child in the configuration hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedConfigurationView
Description

Isolates the view for methods in this session. An isolated view restricts notifications for parameter values to this configuration only.

CompliancemandatoryThis method is must be implemented.
MethodreliableValueNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableValueNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeValueNotification
Description

Acknowledge a value notification.

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

Assigns a callback for notifications of new values. ValueReceiver.newValues() is invoked when a new Value is added to this configuration.

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

Assigns a callback for notifications of new values for the given parameter. ValueReceiver.newValues() is invoked when a new Value is added to this configuration.

Parametersosid.id.IdparameterIdthe Id of the Parameter to monitor
ErrorsNULL_ARGUMENT parameterId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedValues
Description

Assigns a callback for notification of updated parameter values in this configuration. ValueReceiver.changedValues() is invoked when a Value is changed in this configuration.

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

Assigns a callback for notifications of changed values for the given parameter. ValueReceiver.changedValues() is invoked when a Value is updated to this configuration.

Parametersosid.id.IdparameterIdthe Id of the Parameter to monitor
ErrorsNULL_ARGUMENT parameterId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedValue
Description

Assigns a callback for notifications of an update to a value in this configuration. ValueReceiver.changedValues() is invoked when the specified Value is updated in this configuration.

Parametersosid.id.IdvalueIdthe Id of the Value to monitor
ErrorsNULL_ARGUMENT valueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedValues
Description

Assigns a callback for notification of deleted values in this configuration. ValueReceiver.changedValues() is invoked when a Value is removed from this configuration.

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

Assigns a callback for notifications of changed values for the given parameter. ValueReceiver.changedValues() is invoked when a Value is removed from this configuration.

Parametersosid.id.IdparameterIdthe Id of the Parameter to monitor
ErrorsNULL_ARGUMENT parameterId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedValue
Description

Assigns a callback for notifications of an update to a value in this configuration. ValueReceiver.changedValues() is invoked when the specified Value is removed from this configuration.

Parametersosid.id.IdvalueIdthe Id of the Value to monitor
ErrorsNULL_ARGUMENT valueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.