OSID - osid.learning.ObjectiveBankNotificationSession Service Interface Definition

Interface	osid.learning.ObjectiveBankNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `ObjectiveBank` 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 i
Method	canRegisterForObjectiveBankNotifications
Description	Tests if this user can register for `ObjectiveBank` 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	reliableObjectiveBankNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeObjectiveBankNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableObjectiveBankNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeObjectiveBankNotification
Description	Acknowledge an objective 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	registerForNewObjectiveBanks
Description	Register for notifications of new objective banks. `ObjectiveBankReceiver.newObjectiveBanks()` is invoked when a new `ObjectiveBank` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedObjectiveBanks
Description	Registers for notification of updated objective banks. `ObjectiveBankReceiver.changedObjectiveBanks()` is invoked when an objective bank is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedObjectiveBank
Description	Registers for notification of an updated objective bank. `ObjectiveBankReceiver.changedObjectiveBanks()` is invoked when the specified objective bank is changed.
Parameters	`osid.id.Id`	`objectiveBankId`	the `Id` of the objective bank to monitor
Errors	NULL_ARGUMENT		`objectiveBankId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedObjectiveBanks
Description	Registers for notification of deleted objective banks. `ObjectiveBankReceiver.deletedObjectiveBanks()` is invoked when a calenedar is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedObjectiveBank
Description	Registers for notification of a deleted objective bank. `ObjectiveBankReceiver.deletedObjectiveBanks()` is invoked when the specified objective bank is deleted.
Parameters	`osid.id.Id`	`objectiveBankId`	the `Id` of the objective bank to monitor
Errors	NULL_ARGUMENT		`objectiveBankId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedObjectiveBankHierarchy
Description	Registers for notification of an updated objective bank hierarchy structure. `ObjectiveBankReceiver.changedChildOfObjectiveBanks()` 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	registerForChangedObjectiveBankHierarchyForAncestors
Description	Registers for notification of an updated objective bank hierarchy structure. `ObjectiveBankReceiver.changedChildOfObjectiveBanks()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`objectiveBankId`	the `Id` of the `ObjectiveBank` node to monitor
Errors	NULL_ARGUMENT		`objectiveBankId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedObjectiveBankHierarchyForDescendants
Description	Registers for notification of an updated objective bank hierarchy structure. `ObjectiveBankReceiver.changedChildOfObjectiveBanks()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`objectiveBankId`	the `Id` of the `ObjectiveBank` node to monitor
Errors	NULL_ARGUMENT		`objectiveBankId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.