OSID - osid.authorization.FunctionNotificationSession Service Interface Definition

Interface	osid.authorization.FunctionNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive asynchronous notifications on adds/changes to `Function` 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. The two views defined in this session correspond to the views in the `FunctionLookupSession.`
Method	getVaultId
Description	Gets the `Vault` `Id` associated with this session.
Return	`osid.id.Id`		the `Vault Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getVault
Description	Gets the `Vault` associated with this session.
Return	`osid.authorization.Vault`		the `Vault` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForFunctionNotifications
Description	Tests if this user can register for `Function` 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	useFederatedVaultView
Description	Federates the view for methods in this session. A federated view will include functions in vaults which are children of this vault in the vault hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedVaultView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this vault only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableFunctionNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeFunctionNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableFunctionNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeFunctionNotification
Description	Acknowledge a function 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	registerForNewFunctions
Description	Register for notifications of new functions. `FunctionReceiver.newFunctions()` is invoked when a new Function is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFunctions
Description	Registers for notification of updated functions. `FunctionReceiver.changedFunctions()` is invoked when a function is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFunction
Description	Registers for notification of an updated function. `FunctionReceiver.changedFunctions()` is invoked when the specified function is changed.
Parameters	`osid.id.Id`	`functionId`	the `Id` of the `Function` to monitor
Errors	NULL_ARGUMENT		`functionId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedFunctions
Description	Registers for notification of deleted functions. `FunctionReceiver.deletedFunctions()` is invoked when a function is removed from this vault.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedFunction
Description	Registers for notification of a deleted function. `FunctionReceiver.changedFunctions()` is invoked when the specified function is removed from this vault.
Parameters	`osid.id.Id`	`functionId`	the `Id` of the `Function` to monitor
Errors	NULL_ARGUMENT		`functionId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.