OSID - osid.assessment.BankNotificationSession Service Interface Definition

Interface	osid.assessment.BankNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.assessment.AssessmentManager`
Used By	`osid.assessment.AssessmentProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Bank` objects. 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.
Method	canRegisterForBankNotifications
Description	Tests if this user can register for `Bank` 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	reliableBankNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeBankNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableBankNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeBankNotification
Description	Acknowledge a bank 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	registerForNewBanks
Description	Register for notifications of new banks. `BankReceiver.newBanks()` is invoked when a new Bank is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBanks
Description	Registers for notification of updated banks. `BankReceiver.changedBanks()` is invoked when a bank is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBank
Description	Registers for notification of an updated bank. `BankReceiver.changedBanks()` is invoked when the specified bank is changed.
Parameters	`osid.id.Id`	`bankId`	the Id of the bank to monitor
Errors	NULL_ARGUMENT		`bankId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBanks
Description	Registers for notification of deleted banks. `BankReceiver.deletedBanks()` is invoked when a bank is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBank
Description	Registers for notification of a deleted bank. `BankReceiver.deletedBanks()` is invoked when the specified bank is deleted.
Parameters	`osid.id.Id`	`bankId`	the Id of the bank to monitor
Errors	NULL_ARGUMENT		`bankId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBankHierarchy
Description	Registers for notification of an updated bank hierarchy structure. `BankReceiver.changedChildOfBanks()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBankHierarchyForAncestors
Description	Registers for notification of an updated bank hierarchy structure. `BankReceiver.changedChildOfBanks()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`bankId`	the `Id` of the `Bank` node to monitor
Errors	NULL_ARGUMENT		`bankId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBankHierarchyForDescendants
Description	Registers for notification of an updated bank hierarchy structure. `BankReceiver.changedChildOfBanks()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`bankId`	the `Id` of the `Bank` node to monitor
Errors	NULL_ARGUMENT		`bankId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.