Interface | osid.offering.CanonicalUnitNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | getCatalogueId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Catalogue Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogue | ||
Description |
Gets the | ||
Return | osid.offering.Catalogue | the catalogue | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForCanonicalUnitNotifications | ||
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 | useFederatedCatalogueView | ||
Description |
Federates the view for methods in this session. A federated view will include notifications for canonical unitss in catalogues which are children of this catalogue in the catalogue hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCatalogueView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this catalogue only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewCanonicalUnits | ||
Description |
Register for notifications of new canonical units.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCanonicalUnits | ||
Description |
Registers for notification of updated canonical units.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCanonicalUnit | ||
Description |
Registers for notification of an updated canonical
unit. | ||
Parameters | osid.id.Id | canonicalUnitId | the Id of the CanonicalUnit to monitor |
Errors | NOT_FOUND | a canonical unit was not found identified by the given Id | |
NULL_ARGUMENT | canonicalUnitId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCanonicalUnits | ||
Description |
Registers for notification of deleted canonical units.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCanonicalUnit | ||
Description |
Registers for notification of a deleted canonical unit.
| ||
Parameters | osid.id.Id | canonicalUnitId | the Id of the CanonicalUnit to monitor |
Errors | NOT_FOUND | a canonical unit was not found identified by the given Id | |
NULL_ARGUMENT | canonicalUnitId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |