Interface | osid.offering.CatalogueNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the | ||
Method | canRegisterForCatalogueNotifications | ||
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 | registerForNewCatalogues | ||
Description |
Register for notifications of new catalogues. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewCatalogueAncestors | ||
Description |
Registers for notification of an updated hierarchy
structure that introduces a new ancestor of the specified
catalogue. | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue node to monitor |
Errors | NULL_ARGUMENT | catalogueId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewCatalogueDescendants | ||
Description |
Registers for notification of an updated hierarchy
structure that introduces a new descendant of the
specified catalogue. | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue node to monitor |
Errors | NULL_ARGUMENT | catalogueId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCatalogues | ||
Description |
Registers for notification of updated catalogues.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCatalogue | ||
Description |
Registers for notification of an updated catalogue.
| ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue to monitor |
Errors | NULL_ARGUMENT | catalogueId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCatalogues | ||
Description |
Registers for notification of deleted catalogues.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCatalogue | ||
Description |
Registers for notification of a deleted catalogue.
| ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue to monitor |
Errors | NULL_ARGUMENT | catalogueId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCatalogueAncestors | ||
Description |
Registers for notification of an updated hierarchy
structure that removes an ancestor of the specified
catalogue | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue to monitor |
Errors | NULL_ARGUMENT | catalogueId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCatalogueDescendants | ||
Description |
Registers for notification of an updated hierarchy
structure that removes a descendant of the specified
catalogue. | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue to monitor |
Errors | NULL_ARGUMENT | catalogueId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |