| Interface | osid.acknowledgement.BillingNotificationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the | ||
| Method | canRegisterForBillingNotifications | ||
| 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 | reliableBillingNotifications | ||
| Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | unreliableBillingNotifications | ||
| Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | acknowledgeBillingNotification | ||
| Description |
Acknowledge a billing 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 | registerForNewBillings | ||
| Description |
Register for notifications of new billings. | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedBillings | ||
| Description |
Registers for notification of updated billings. | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedBilling | ||
| Description |
Registers for notification of an updated billing.
| ||
| Parameters | osid.id.Id | billingId | the Id of the Billing to monitor |
| Errors | NULL_ARGUMENT | billingId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedBillings | ||
| Description |
Registers for notification of deleted billings. | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedBilling | ||
| Description |
Registers for notification of a deleted billing. | ||
| Parameters | osid.id.Id | billingId | the Id of the Billing to monitor |
| Errors | NULL_ARGUMENT | billingId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedBillingHierarchy | ||
| Description |
Registers for notification of an updated billing
hierarchy structure. | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedBillingHierarchyForAncestors | ||
| Description |
Registers for notification of an updated billing
hierarchy structure. | ||
| Parameters | osid.id.Id | billingId | the Id of the Billing node to monitor |
| Errors | NULL_ARGUMENT | billingId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedBillingHierarchyForDescendants | ||
| Description |
Registers for notification of an updated billing
hierarchy structure. | ||
| Parameters | osid.id.Id | billingId | the Id of the Billing node to monitor |
| Errors | NULL_ARGUMENT | billingId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |