| Interface | osid.financials.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 | 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 | registerForNewBusinessAncestors | ||
| Description |
Registers for notification if an ancestor is added to
the specified business in the business hierarchy. | ||
| 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 | registerForNewBusinessDescendants | ||
| Description |
Registers for notification if a descendant is added to
the specified business in the business hierarchy. | ||
| 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 | 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 | registerForDeletedBusinessAncestors | ||
| Description |
Registers for notification if an ancestor is removed
from the specified business in the business hierarchy.
| ||
| 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 | registerForDeletedBusinessDescendants | ||
| Description |
Registers for notification if a descendant is removed
from fthe specified business in the business hierarchy.
| ||
| 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. | |