OSID - osid.recipe.ProcedureNotificationSession Service Interface Definition

Interface	osid.recipe.ProcedureNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.recipe.RecipeManager`
Used By	`osid.recipe.RecipeProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Procedure` 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	getCookbookId
Description	Gets the `Cookbook` `Id` associated with this session.
Return	`osid.id.Id`		the `Cookbook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCookbook
Description	Gets the `Cookbook` associated with this session.
Return	`osid.recipe.Cookbook`		the cookbook
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForProcedureNotifications
Description	Tests if this user can register for `Procedure` 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	useFederatedCookbookView
Description	Federates the view for methods in this session. A federated view will include procedures in cookbooks which are children of this cookbook in the cookbook hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCookbookView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this cookbook only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableProcedureNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeProcedureNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableProcedureNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeProcedureNotification
Description	Acknowledge a procedure 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	registerForNewProcedures
Description	Register for notifications of new procedures. `ProcedureReceiver.newProcedures()` is invoked when a new `Procedure` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProcedures
Description	Registers for notification of updated procedures. `ProcedureReceiver.changedProcedures()` is invoked when a procedure is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProcedure
Description	Registers for notification of an updated procedure. `ProcedureReceiver.changedProcedures()` is invoked when the specified procedure is changed.
Parameters	`osid.id.Id`	`procedureId`	the `Id` of the `Procedure` to monitor
Errors	NULL_ARGUMENT		`procedureId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProcedures
Description	Registers for notification of deleted procedures. `ProcedureReceiver.deletedProcedures()` is invoked when a procedure is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProcedure
Description	Registers for notification of a deleted procedure. `ProcedureReceiver.deletedProcedures()` is invoked when the specified procedure is deleted.
Parameters	`osid.id.Id`	`procedureId`	the `Id` of the `Procedure` to monitor
Errors	NULL_ARGUMENT		`procedureId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.