Interface | osid.logging.LogEntryNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on new or deleted log entries. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. Notifications are triggered with changes to assignments of
| ||
Method | getLogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Log Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getLog | ||
Description |
Gets the | ||
Return | osid.logging.Log | the Log associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForLogEntryNotifications | ||
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 | useFederatedLogView | ||
Description |
Federates the view for methods in this session. A federated view will include entries from parent logs in the log hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedLogView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications for entries to this log only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableLogEntryNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableLogEntryNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeLogEntryNotification | ||
Description |
Acknowledge a log entry 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 | registerForNewLogEntries | ||
Description |
Register for notifications of new log entries. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewLogEntriesAtPriority | ||
Description |
Register for notifications of new log entries at or
above the given priority type. | ||
Parameters | osid.type.Type | priorityType | a priority type |
Errors | NULL_ARGUMENT | priorityType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewLogEntriesForResource | ||
Description |
Register for notifications of new log entries logged by
an agent associated with the given resource. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedLogEntries | ||
Description |
Register for notifications of updated log entries.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedEntriesAtPriority | ||
Description |
Register for notifications of updated log entries at or
above the given priority type. | ||
Parameters | osid.type.Type | priorityType | a priority type |
Errors | NULL_ARGUMENT | priorityType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedEntriesForResource | ||
Description |
Register for notifications of updated log entries
logged by an agent associated with the given resource.
| ||
Parameters | osid.id.Id | resourceId | a resource Id |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedLogEntry | ||
Description |
Registers for notification of an updated log entry.
| ||
Parameters | osid.id.Id | logEntryId | the Id of the LogEntry to monitor |
Errors | NULL_ARGUMENT | logEntryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedLogEntries | ||
Description |
Registers for notification of deleted log entries.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedLogEntriesAtPriority | ||
Description |
Register for notifications of deleted log entries at or
above the given priority type. | ||
Parameters | osid.type.Type | priorityType | a priority type |
Errors | NULL_ARGUMENT | priorityType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedLogEntriesForResource | ||
Description |
Register for notifications of deleted log entries
logged by an agent associated with the given resource.
| ||
Parameters | osid.id.Id | resourceId | a resource Id |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedLogEntry | ||
Description |
Registers for notification of a deleted log entry.
| ||
Parameters | osid.id.Id | logEntryId | the Id of the LogEntry to monitor |
Errors | NULL_ARGUMENT | logEntryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |