Interface | osid.configuration.ValueNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
changes to Two views are defined;
The methods | ||
Method | getConfigurationId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Configuration Id associated with this
session | |
Compliance | mandatory | This method must be implemented. | |
Method | getConfiguration | ||
Description |
Gets the | ||
Return | osid.configuration.Configuration | the Configuration associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForValueNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedConfigurationView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedConfigurationView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications for parameter values to this configuration only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableValueNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableValueNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeValueNotification | ||
Description |
Acknowledge a value notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewValues | ||
Description |
Assigns a callback for notifications of new values.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewValuesForParameter | ||
Description |
Assigns a callback for notifications of new values for
the given parameter. | ||
Parameters | osid.id.Id | parameterId | the Id of the Parameter to monitor |
Errors | NULL_ARGUMENT | parameterId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedValues | ||
Description |
Assigns a callback for notification of updated
parameter values in this configuration. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedValuesForParameter | ||
Description |
Assigns a callback for notifications of changed values
for the given parameter. | ||
Parameters | osid.id.Id | parameterId | the Id of the Parameter to monitor |
Errors | NULL_ARGUMENT | parameterId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedValue | ||
Description |
Assigns a callback for notifications of an update to a
value in this configuration. | ||
Parameters | osid.id.Id | valueId | the Id of the Value to monitor |
Errors | NULL_ARGUMENT | valueId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedValues | ||
Description |
Assigns a callback for notification of deleted values
in this configuration. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedValuesForParameter | ||
Description |
Assigns a callback for notifications of changed values
for the given parameter. | ||
Parameters | osid.id.Id | parameterId | the Id of the Parameter to monitor |
Errors | NULL_ARGUMENT | parameterId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedValue | ||
Description |
Assigns a callback for notifications of an update to a
value in this configuration. | ||
Parameters | osid.id.Id | valueId | the Id of the Value to monitor |
Errors | NULL_ARGUMENT | valueId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |