OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.AccountNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Account objects 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.Idthe Business Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBusiness
Description

Gets the Business associated with this session.

Returnosid.financials.Businessthe business
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis 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
CompliancemandatoryThis 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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBusinessView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewAccounts
Description

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

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewAccountAncestors
Description

Registers for notification if an ancestor is added to the specified account in the account hierarchy. AccountReceiver.newAccountAncestor() is invoked when the specified account experiences an addition in ancestry.

Parametersosid.id.IdaccountIdthe Id of the account to monitor
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewAccountDescendants
Description

Registers for notification if a descendant is added to the specified account in the account hierarchy. AccountReceiver.newAccountDescendant() is invoked when the specified account experiences an addition in descendants.

Parametersosid.id.IdaccountIdthe Id of the account to monitor
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis 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.IdaccountIdthe Id of the Account to monitor
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis 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.IdaccountIdthe Id of the Account to monitor
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAccountAncestors
Description

Registers for notification if an ancestor is removed from the specified account in the account hierarchy. AccountReceiver.deletedAccountAncestor() is invoked when the specified account experiences a removal of an ancestor.

Parametersosid.id.IdaccountIdthe Id of the account to monitor
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAccountDescendants
Description

Registers for notification if a descendant is removed from fthe specified account in the account hierarchy. AccountReceiver.deletedAccountDescednant() is invoked when the specified account experiences a removal of one of its descdendents.

Parametersosid.id.IdaccountIdthe Id of the account to monitor
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.