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

This session defines methods to receive notifications on adds/changes to Configurations and their properties. 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 federateParameterView() and isolateParameterView() 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.
MethodcanRegisterForParameterNotifications
Description

Tests if this user can register for Parameter 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 registries 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.
MethodreliableParameterNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableParameterNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeParameterNotification
Description

Acknowledge a parameter notification.

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

Assigns a callback for notifications of new parameters. ParameterReceiver.newParameters() is invoked when a new Parameter is added to this configuration.

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

Assigns a callback for notification of updated parameters. ParameterReceiver.changedParameters() is invoked when a Parameter is changed in this configuration.

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

Assigns a callback for notifications of an update to a parameter. ParamaterReceiver.changedParameters() is invoked when the specified Parameter is changed in 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.
MethodregisterForDeletedParameters
Description

Assigns a callback for notification of deleted parameters. ParameterReceiver.deletedParamaters() is invoked when a Parameter is deleted or removed from this configuration.

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

Assigns a callback for notifications of a deleted parameter. ParameterReceiver.deletedParameters() is invoked when the specified Parameter is deleted or 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.