Interface | osid.offering.rules.CanonicalUnitEnablerNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
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 | canRegisterForCanonicalUnitEnablerNotifications | ||
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 enablers 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 | reliableCanonicalUnitEnablerNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableCanonicalUnitEnablerNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeCanonicalUnitEnablerNotification | ||
Description |
Acknowledge a canonical unit enabler 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 | registerForNewCanonicalUnitEnablers | ||
Description |
Register for notifications of new canonical unit
enablers. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCanonicalUnitEnablers | ||
Description |
Registers for notification of updated canonical unit
enablers. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCanonicalUnitEnabler | ||
Description |
Registers for notification of an updated canonical unit
enabler. | ||
Parameters | osid.id.Id | canonicalUnitEnablerId | the Id of the CanonicalUnitEnabler to monitor |
Errors | NULL_ARGUMENT | canonicalUnitEnablerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCanonicalUnitEnablers | ||
Description |
Registers for notification of deleted canonical unit
enablers. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCanonicalUnitEnabler | ||
Description |
Registers for notification of a deleted canonical unit
enabler. | ||
Parameters | osid.id.Id | canonicalUnitEnablerId | the Id of the CanonicalUnitEnabler to monitor |
Errors | NULL_ARGUMENT | canonicalUnitEnablerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |