Interface | osid.logging.LogNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the | ||
Method | canRegisterForLogNotifications | ||
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 | reliableLogNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableLogNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeLogNotification | ||
Description |
Acknowledge a log 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 | registerForNewLogs | ||
Description |
Register for notifications of new logs. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedLogs | ||
Description |
Registers for notification of updated logs. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedLog | ||
Description |
Registers for notification of an updated log. | ||
Parameters | osid.id.Id | logId | the Id of the Log to monitor |
Errors | NULL_ARGUMENT | logId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedLogs | ||
Description |
Registers for notification of deleted logs. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedLog | ||
Description |
Registers for notification of a deleted log. | ||
Parameters | osid.id.Id | logId | the Id of the Log to monitor |
Errors | NULL_ARGUMENT | logId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedLogHierarchy | ||
Description |
Registers for notification of an updated log hierarchy
structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedLogHierarchyForAncestors | ||
Description |
Log | ||
Parameters | osid.id.Id | logId | the Id of the Log node to monitor |
Errors | NULL_ARGUMENT | logId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedLogHierarchyForDescendants | ||
Description |
Registers for notification of an updated log hierarchy
structure. | ||
Parameters | osid.id.Id | logId | the Id of the Log node to monitor |
Errors | NULL_ARGUMENT | logId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |