OSID - osid.financials.AccountNotificationSession Service Interface Definition

Interface	osid.financials.AccountNotificationSession
Implements	`osid.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.`
Method	getBusinessId
Description	Gets the `Business` `Id` associated with this session.
Return	`osid.id.Id`		the `Business Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBusiness
Description	Gets the `Business` associated with this session.
Return	`osid.financials.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForAccountNotifications
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.
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. `AccountReceiver.newAccounts()` is invoked when a new `Account` appears in this business.
Errors	OPERATION_FAILED		unable to complete request
Errors	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. `AccountReceiver.newAccountAncestor()` is invoked when the specified account experiences an addition in ancestry.
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. `AccountReceiver.newAccountDescendant()` is invoked when the specified account experiences an addition in descendants.
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. `AccountReceiver.changedAccounts()` is invoked when an account in this business is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAccount
Description	Registers for notification of an updated account. `AccountReceiver.changedAccounts()` is invoked when the specified account in this business is changed.
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. `AccountReceiver.deletedAccounts()` is invoked when an account is deleted or removed from this business.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAccount
Description	Registers for notification of a deleted account. `AccountReceiver.deletedAccounts()` is invoked when the specified account is deleted or removed from this business.
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. `AccountReceiver.deletedAccountAncestor()` is invoked when the specified account experiences a removal of an ancestor.
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. `AccountReceiver.deletedAccountDescednant()` is invoked when the specified account experiences a removal of one of its descdendents.
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.