org.osid.financials

Interface AccountNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AccountNotificationSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForAccountNotifications() Tests if this user can register for Account notifications.
Business	getBusiness() Gets the Business associated with this session.
Id	getBusinessId() Gets the Business Id associated with this session.
void	registerForChangedAccount(Id accountId) Registers for notification of an updated account.
void	registerForChangedAccounts() Registers for notification of updated accounts.
void	registerForDeletedAccount(Id accountId) Registers for notification of a deleted account.
void	registerForDeletedAccountAncestors(Id accountId) Registers for notification if an ancestor is removed from the specified account in the account hierarchy.
void	registerForDeletedAccountDescendants(Id accountId) Registers for notification if a descendant is removed from fthe specified account in the account hierarchy.
void	registerForDeletedAccounts() Registers for notification of deleted accounts.
void	registerForNewAccountAncestors(Id accountId) Registers for notification if an ancestor is added to the specified account in the account hierarchy.
void	registerForNewAccountDescendants(Id accountId) Registers for notification if a descendant is added to the specified account in the account hierarchy.
void	registerForNewAccounts() Register for notifications of new accounts.
void	useFederatedBusinessView() Federates the view for methods in this session.
void	useIsolatedBusinessView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getBusinessId

Id getBusinessId()

Gets the Business Id associated with this session.

Returns:

the Business Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBusiness

Business getBusiness()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Business associated with this session.

Returns:

the business

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForAccountNotifications

boolean canRegisterForAccountNotifications()

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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedBusinessView

void useFederatedBusinessView()

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.

useIsolatedBusinessView

void useIsolatedBusinessView()

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.

registerForNewAccounts

void registerForNewAccounts()
                            throws OperationFailedException,
                                   PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewAccountAncestors

void registerForNewAccountAncestors(Id accountId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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.

Parameters:

accountId - the Id of the account to monitor

Throws:

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewAccountDescendants

void registerForNewAccountDescendants(Id accountId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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.

Parameters:

accountId - the Id of the account to monitor

Throws:

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAccounts

void registerForChangedAccounts()
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAccount

void registerForChangedAccount(Id accountId)
                               throws OperationFailedException,
                                      PermissionDeniedException

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

Parameters:

accountId - the Id of the Account to monitor

Throws:

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAccounts

void registerForDeletedAccounts()
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAccount

void registerForDeletedAccount(Id accountId)
                               throws OperationFailedException,
                                      PermissionDeniedException

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

Parameters:

accountId - the Id of the Account to monitor

Throws:

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAccountAncestors

void registerForDeletedAccountAncestors(Id accountId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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.

Parameters:

accountId - the Id of the account to monitor

Throws:

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAccountDescendants

void registerForDeletedAccountDescendants(Id accountId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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.

Parameters:

accountId - the Id of the account to monitor

Throws:

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.