OSID - osid.recipe.CookbookNotificationSession Service Interface Definition

Interface	osid.recipe.CookbookNotificationSession
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 `Cookbook` 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. Notifications are triggered with changes to the `Cookbook` object itself. Adding and removing procedures result in notifications available from the notification session for procedures.
Method	canRegisterForCookbookNotifications
Description	Tests if this user can register for `Cookbook` 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	reliableCookbookNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCookbookNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCookbookNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCookbookNotification
Description	Acknowledge a cookbook 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	registerForNewCookbooks
Description	Register for notifications of new cookbooks. `CookbookReceiver.newCookbooks()` is invoked when a new `Cookbook` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCookbooks
Description	Registers for notification of updated cookbooks. `CookbookReceiver.changedCookbook()` is invoked when a cookbook is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCookbook
Description	Registers for notification of an updated cookbook. `CookbookReceiver.changedCookbooks()` is invoked when the specified cookbook is changed.
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of the `Cookbook` to monitor
Errors	NULL_ARGUMENT		`cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCookbooks
Description	Registers for notification of deleted cookbooks. `CookbookReceiver.deletedCookbooks()` is invoked when a cookbook is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCookbook
Description	Registers for notification of a deleted cookbook. `CookbookReceiver.deletedCookbooks()` is invoked when the specified cookbook is deleted.
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of the `Cookbook` to monitor
Errors	NULL_ARGUMENT		`cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCookbookHierarchy
Description	Registers for notification of an updated cookbooks hierarchy structure. `CookbookReceiver.changedChildOfCookbooks()` is invoked when the specified node or any of its descendants 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	registerForChangedCookbookHierarchyForAncestors
Description	Registers for notification of an updated cookbooks hierarchy structure. `CookbookReceiver.changedChildOfCookbooks()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of the `Cookbook` node to monitor
Errors	NULL_ARGUMENT		`cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCookbookHierarchyForDescendants
Description	Registers for notification of an updated cookbooks hierarchy structure. `CookbookReceiver.changedChildOfCookbooks()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of the `Cookbook` node to monitor
Errors	NULL_ARGUMENT		`cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.