| Interface | osid.offering.rules.OfferingConstrainerEnablerNotificationSession | ||
|---|---|---|---|
| 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 | canRegisterForOfferingConstrainerEnablerNotifications | ||
| 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 | reliableOfferingConstrainerEnablerNotifications | ||
| Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | unreliableOfferingConstrainerEnablerNotifications | ||
| Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | acknowledgeOfferingConstrainerEnablerNotification | ||
| Description |
Acknowledge an offering constrainer 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 | registerForNewOfferingConstrainerEnablers | ||
| Description |
Register for notifications of new offering constrainer
enablers. | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedOfferingConstrainerEnablers | ||
| Description |
Registers for notification of updated offering
constrainer enablers. | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedOfferingConstrainerEnabler | ||
| Description |
Registers for notification of an updated offering
constrainer enabler. | ||
| Parameters | osid.id.Id | offeringConstrainerEnablerId | the Id of the OfferingConstrainerEnabler to
monitor |
| Errors | NULL_ARGUMENT | offeringConstrainerEnablerId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedOfferingConstrainerEnablers | ||
| Description |
Registers for notification of deleted offering
constrainer enablers. | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedOfferingConstrainerEnabler | ||
| Description |
Registers for notification of a deleted offering
constrainer enabler. | ||
| Parameters | osid.id.Id | offeringConstrainerEnablerId | the Id of the OfferingConstrainerEnabler to
monitor |
| Errors | NULL_ARGUMENT | offeringConstrainerEnablerId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |