Interface | osid.billing.BusinessNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | canRegisterForBusinessNotifications | ||
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 | reliableBusinessNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableBusinessNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeBusinessNotification | ||
Description |
Acknowledge a business 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 | registerForNewBusinesses | ||
Description |
Register for notifications of new businesses. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedBusinesses | ||
Description |
Registers for notification of updated businesses.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedBusiness | ||
Description |
Registers for notification of an updated business.
| ||
Parameters | osid.id.Id | businessId | the Id of the Business to monitor |
Errors | NULL_ARGUMENT | businessId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedBusinesses | ||
Description |
Registers for notification of deleted businesses.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedBusiness | ||
Description |
Registers for notification of a deleted business.
| ||
Parameters | osid.id.Id | businessId | the Id of the Business to monitor |
Errors | NULL_ARGUMENT | businessId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedBusinessHierarchy | ||
Description |
Registers for notification of an updated business
hierarchy structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedBusinessHierarchyForAncestors | ||
Description |
Registers for notification of an updated business
hierarchy structure. | ||
Parameters | osid.id.Id | businessId | the Id of the Business node to monitor |
Errors | NULL_ARGUMENT | businessId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedBusinessHierarchyForDescendants | ||
Description |
Registers for notification of an updated business
hierarchy structure. | ||
Parameters | osid.id.Id | businessId | the Id of the Business node to monitor |
Errors | NULL_ARGUMENT | businessId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |