Interface | osid.cataloging.CatalogEntryNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on adds/changes to a catalog assignment. 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 | getCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Catalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalog | ||
Description |
Gets the | ||
Return | osid.cataloging.Catalog | the catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForCatalogEntryNotifications | ||
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 | useFederatedCatalogView | ||
Description |
Federates the view for methods in this session. A federated view will include entries from parent catalogs in the catalog hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCatalogView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications for entries to this catalog only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableCatalogEntryNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableCatalogEntryNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeCatalogEntryNotification | ||
Description |
Acknowledge a catalog 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 | registerForNewCatalogEntries | ||
Description |
Register for notifications of new catalogs. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCatalogEntries | ||
Description |
Registers for notification of deleted catalogs entries.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |