Interface | osid.configuration.ConfigurationNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | canRegisterForConfigurationNotifications | ||
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 | reliableConfigurationNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableConfigurationNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeConfigurationNotification | ||
Description |
Acknowledge a configuration 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 | registerForNewConfigurations | ||
Description |
Registers for notifications of new configurations.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedConfigurations | ||
Description |
Registers for notification of updated configurations.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedConfiguration | ||
Description |
Registers for notifications of an update to a
configuration. | ||
Parameters | osid.id.Id | configurationId | the Id of the Configuration to monitor |
Errors | NOT_FOUND | a Configuration was not found identified by the given
Id | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedConfigurations | ||
Description |
Registers for notification of deleted configurations.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedConfiguration | ||
Description |
Registers for notifications of a deleted configuration.
| ||
Parameters | osid.id.Id | configurationId | the Id of the Configuration to monitor |
Errors | NOT_FOUND | a Configuration was not found identified by the given
Id | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedConfigurationHierarchy | ||
Description |
Registers for notification of an updated configuration
hierarchy structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedConfigurationHierarchyForAncestors | ||
Description |
Registers for notification of an updated configuration
hierarchy structure. | ||
Parameters | osid.id.Id | configurationId | the Id of the Configuration node to monitor |
Errors | NULL_ARGUMENT | configurationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedConfigurationHierarchyForDescendants | ||
Description |
Registers for notification of an updated configuration
hierarchy structure. | ||
Parameters | osid.id.Id | configurationId | the Id of the Configuration node to monitor |
Errors | NULL_ARGUMENT | configurationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |