OSID - osid.recipe.CookbookNotificationSession Service Interface Definition

Interface	osid.recipe.CookbookNotificationSession
Implements	`osid.OsidSession`
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	registerForNewCookbooks
Description	Register for notifications of new cook books. `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	registerForNewCookbookAncestors
Description	Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified cookbook. `CookbookReceiver.newAncestorCookbook()` is invoked when the specified cook book node gets a new ancestor.
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	registerForNewCookbookDescendants
Description	Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified cookbook. `CookbookReceiver.newDescendantCookbook()` is invoked when the specified cook book node gets a new descendant.
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	registerForChangedCookbooks
Description	Registers for notification of updated cook books. `CookbookReceiver.changedCookbook()` is invoked when a cook book 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 cook book 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 cook books. `CookbookReceiver.deletedCookbooks()` is invoked when a cook book 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 cook book 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	registerForDeletedCookbookAncestors
Description	Registers for notification of an updated hierarchy structure that removes an ancestor of the specified cook book `CookbookReceiver.deletedAncestor()` is invoked when the specified cook book node loses an ancestor.
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	registerForDeletedCookbookDescendants
Description	Registers for notification of an updated hierarchy structure that removes a descendant of the specified cookbook. `CookbookReceiver.deletedDescendant()` is invoked when the specified cook book node loses a descendant.
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.