OSID - osid.recipe.RecipeNotificationSession Service Interface Definition

Interface	osid.recipe.RecipeNotificationSession
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 `Recipe` objects in this `Cookbook`. This also includes existing recipes that may appear or disappear due to changes in the `Cookbook` hierarchy, 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 `RecipeLookupSession`.
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	canRegisterForRecipeNotifications
Description	Tests if this user can register for `Recipe` 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 recipes 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 notifications to this cookbook only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableRecipeNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRecipeNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRecipeNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRecipeNotification
Description	Acknowledge a recipe 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	registerForNewRecipes
Description	Register for notifications of new recipes. `RecipeReceiver.newRecipes()` is invoked when a new `Recipe` appears in this cookbook.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRecipes
Description	Registers for notification of updated recipes. `RecipeReceiver.changedRecipes()` is invoked when a recipe in this cookbook is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRecipe
Description	Registers for notification of an updated recipe. `RecipeReceiver.changedRecipes()` is invoked when the specified recipe in this cookbook is changed.
Parameters	`osid.id.Id`	`recipeId`	the `Id` of the `Recipe` to monitor
Errors	NOT_FOUND		a recipe was not found in this cookbook identified by the given `Id`
	NULL_ARGUMENT		`recipeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRecipes
Description	Registers for notification of deleted recipes. `RecipeReceiver.deletedRecipes()` is invoked when a recipe is deleted or removed from this cookbook.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRecipe
Description	Registers for notification of a deleted recipe. `RecipeReceiver.deletedRecipes()` is invoked when the specified recipe is deleted or removed from this cookbook.
Parameters	`osid.id.Id`	`recipeId`	the `Id` of the `Recipe` to monitor
Errors	NOT_FOUND		a recipe was not found identified by the given `Id`
	NULL_ARGUMENT		`recipeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.