OSID - osid.financials.budgeting.BudgetEntryNotificationSession Service Interface Definition

Interface	osid.financials.budgeting.BudgetEntryNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.financials.budgeting.FinancialsBudgetingManager`
Used By	`osid.financials.budgeting.FinancialsBudgetingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `BudgetEntries`. in this `Business`. This also includes existing budget entries 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 `BudgetEntryLookupSession`.
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	canRegisterForBudgetEntryNotifications
Description	Tests if this user can register for `BudgetEntry` 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 budget entries 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	reliableBudgetEntryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeBudgetEntryNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableBudgetEntryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeBudgetEntryNotification
Description	Acknowledge a budget entry notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewBudgetEntries
Description	Register for notifications of new budget entries. `BudgetEntryReceiver.newBudgetEntries()` is invoked when a new `BudgetEntry` appears in this business.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewBudgetEntriesForBudget
Description	Register for notifications of new budget entries for the given budget. `BudgetEntryReceiver.newBudgetEntries()` is invoked when a new `BudgetEntry` appears in this business.
Parameters	`osid.id.Id`	`budgetId`	the `Id` of the `Budget` to monitor
Errors	NULL_ARGUMENT		`budgetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewBudgetEntriesForAccount
Description	Register for notifications of new budget entries for the given account. `BudgetEntryReceiver.newBudgetEntries()` is invoked when a new `BudgetEntry` appears in 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	registerForChangedBudgetEntries
Description	Registers for notification of updated budget entries. `BudgetEntryReceiver.changedBudgetEntries()` is invoked when a budget entry 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	registerForChangedBudgetEntriesForBudget
Description	Registers for notification of updated budget entries for the given budget. `BudgetEntryReceiver.changedBudgetEntries()` is invoked when the specified budget entry in this business is changed.
Parameters	`osid.id.Id`	`budgetId`	the `Id` of the `Budget` to monitor
Errors	NULL_ARGUMENT		`budgetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBudgetEntriesForAccount
Description	Registers for notification of updated budget entries for the given account. `BudgetEntryReceiver.changedBudgetEntries()` is invoked when the specified budget entry 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	registerForChangedBudgetEntry
Description	Registers for notification of an updated budget entries. `BudgetEntryReceiver.changedBudgetEntries()` is invoked when the specified budget entry in this business is changed.
Parameters	`osid.id.Id`	`budgetEntryId`	the `Id` of the `BudgetEntry` to monitor
Errors	NULL_ARGUMENT		`budgetEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBudgetEntries
Description	Registers for notification of deleted budget entries. `BudgetEntryReceiver.deletedBudgetEntries()` is invoked when a budget entry 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	registerForDeletedBudgetEntriesForBudget
Description	Registers for notification of deleted budget entries for the given budget. `BudgetEntryReceiver.deletedBudgetEntries()` is invoked when the specified budget entry is deleted or removed from this business.
Parameters	`osid.id.Id`	`budgetId`	the `Id` of the `Budget` to monitor
Errors	NULL_ARGUMENT		`budgetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBudgetEntriesForAccount
Description	Registers for notification of deleted budget entries for the given acount. `BudgetEntryReceiver.deletedBudgetEntries()` is invoked when the specified budget entry 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	registerForDeletedBudgetEntry
Description	Registers for notification of a deleted budget entries. `BudgetEntryReceiver.deletedBudgetEntries()` is invoked when the specified budget entry is deleted or removed from this business.
Parameters	`osid.id.Id`	`budgetEntryId`	the `Id` of the `BudgetEntry` to monitor
Errors	NULL_ARGUMENT		`budgetEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.