OSID Logo
OSID Specifications
financials package
Version 3.1.0
Interfaceosid.financials.AccountNotificationSession
Implementsosid.OsidSession
Used Byosid.financials.FinancialsManager
osid.financials.FinancialsProxyManager
Description

This session defines methods to receive notifications on adds/changes to Accounts in this Business. This also includes existing accounts that may appear or disappear due to changes in the Business hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the AccountLookupSession.

MethodgetBusinessId
Description

Gets the Business Id associated with this session.

Returnosid.id.Id the Business Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetBusiness
Description

Gets the Business associated with this session.

Returnosid.financials.Business the business
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanRegisterForAccountNotifications
Description

Tests if this user can register for Account notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer notification operations.

Returnboolean false if notification methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethoduseFederatedBusinessView
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.

Compliancemandatory This method is must be implemented.
MethoduseIsolatedBusinessView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this business only.

Compliancemandatory This method is must be implemented.
MethodreliableAccountNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeAccountNotification().

Compliancemandatory This method is must be implemented.
MethodunreliableAccountNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

Compliancemandatory This method is must be implemented.
MethodacknowledgeAccountNotification
Description

Acknowledge ana ccount notification.

Parametersosid.id.IdnotificationId the Id of the notification
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForNewAccounts
Description

Register for notifications of new accounts. AccountReceiver.newAccounts() is invoked when a new Account appears in this business.

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedAccounts
Description

Registers for notification of updated accounts. AccountReceiver.changedAccounts() is invoked when an account in this business is changed.

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedAccount
Description

Registers for notification of an updated account. AccountReceiver.changedAccounts() is invoked when the specified account in this business is changed.

Parametersosid.id.IdaccountId the Id of the Account to monitor
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForDeletedAccounts
Description

Registers for notification of deleted accounts. AccountReceiver.deletedAccounts() is invoked when an account is deleted or removed from this business.

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForDeletedAccount
Description

Registers for notification of a deleted account. AccountReceiver.deletedAccounts() is invoked when the specified account is deleted or removed from this business.

Parametersosid.id.IdaccountId the Id of the Account to monitor
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedAccountHierarchy
Description

Registers for notification of an updated account hierarchy structure. accountId is null AccountReceiver.changedChildOfAccounts() is invoked when a node experiences a change in its children.

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedAccountHierarchyForAncestors
Description

Registers for notification of an updated account hierarchy structure. AccountReceiver.changedChildOfAccounts() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdaccountId the Id of the Account node to monitor
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedAccountHierarchyForDescendants
Description

Registers for notification of an updated acount hierarchy structure. AccountReceiver.changedChildOfAccounts() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdaccountId the Id of the Account node to monitor
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.