Interface | osid.financials.AccountNotificationSession | ||
---|---|---|---|
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 | getBusinessId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Business Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusiness | ||
Description |
Gets the | ||
Return | osid.financials.Business | the business | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForAccountNotifications | ||
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 | useFederatedBusinessView | ||
Description |
Federates the view for methods in this session. A federated view will include accounts in catalogs which are children of this catalog in the business hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBusinessView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this business only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewAccounts | ||
Description |
Register for notifications of new accounts. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewAccountAncestors | ||
Description |
Registers for notification if an ancestor is added to
the specified account in the account hierarchy. | ||
Parameters | osid.id.Id | accountId | the Id of the account to monitor |
Errors | NULL_ARGUMENT | accountId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewAccountDescendants | ||
Description |
Registers for notification if a descendant is added to
the specified account in the account hierarchy. | ||
Parameters | osid.id.Id | accountId | the Id of the account to monitor |
Errors | NULL_ARGUMENT | accountId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAccounts | ||
Description |
Registers for notification of updated accounts. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAccount | ||
Description |
Registers for notification of an updated account.
| ||
Parameters | osid.id.Id | accountId | the Id of the Account to monitor |
Errors | NULL_ARGUMENT | accountId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAccounts | ||
Description |
Registers for notification of deleted accounts. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAccount | ||
Description |
Registers for notification of a deleted account. | ||
Parameters | osid.id.Id | accountId | the Id of the Account to monitor |
Errors | NULL_ARGUMENT | accountId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAccountAncestors | ||
Description |
Registers for notification if an ancestor is removed
from the specified account in the account hierarchy.
| ||
Parameters | osid.id.Id | accountId | the Id of the account to monitor |
Errors | NULL_ARGUMENT | accountId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAccountDescendants | ||
Description |
Registers for notification if a descendant is removed
from fthe specified account in the account hierarchy.
| ||
Parameters | osid.id.Id | accountId | the Id of the account to monitor |
Errors | NULL_ARGUMENT | accountId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |