OSID - osid.recipe.RecipeCookbookAssignmentSession Service Interface Definition

Interface	osid.recipe.RecipeCookbookAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.recipe.RecipeManager`
Used By	`osid.recipe.RecipeProxyManager`
Description	This session provides methods to re-assign `Recipes` to `Cookbook` mappings. A `Recipe` may appear in multiple `Cookbook` objects and removing the last reference to a `Recipe` is the equivalent of deleting it. Each `Cookbook` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `Recipe` to another `Cookbook` is not a copy operation (eg: does not change its `Id`).
Method	canAssignRecipes
Description	Tests if this user can alter recipe/cookbook mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if ingredient is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignRecipesToCookbook
Description	Tests if this user can alter recipe/cookbook mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 lookup operations to unauthorized users.
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of the `Cookbook`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`cookbookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableCookbookIds
Description	Gets a list of cookbooks including and under the given cookbook node in which any recipe can be assigned.
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of the `Cookbook`
Return	`osid.id.IdList`		list of assignable cookbook `Ids`
Errors	NULL_ARGUMENT		`cookbookId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableCookbookIdsForRecipe
Description	Gets a list of cookbooks including and under the given cookbook node in which a specific recipe can be assigned.
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of the `Cookbook`
Parameters	`osid.id.Id`	`recipeId`	the `Id` of the `Recipe`
Return	`osid.id.IdList`		list of assignable cookbook `Ids`
Errors	NULL_ARGUMENT		`cookbookId` or `recipeId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignRecipeToCookbook
Description	Adds an existing `Recipe` to a `Cookbook`.
Parameters	`osid.id.Id`	`recipeId`	the `Id` of the `Recipe`
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of the `Cookbook`
Errors	ALREADY_EXISTS		`recipeId` is not assigned to `cookbookId`
	NOT_FOUND		`recipeId` or `cookbookId` not found
	NULL_ARGUMENT		`recipeId` or `cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignRecipeFromCookbook
Description	Removes a `Recipe` from a `Cookbook`.
Parameters	`osid.id.Id`	`recipeId`	the `Id` of the `Recipe`
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of the `Cookbook`
Errors	NOT_FOUND		`recipeId` or `cookbookId` not found or `recipeId` not assigned to `cookbookId`
	NULL_ARGUMENT		`recipeId` or `cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignRecipeToCookbook
Description	Moves a `Recipe` from one `Cookbook` to another. Mappings to other `Cookbooks` are unaffected.
Parameters	`osid.id.Id`	`recipeId`	the `Id` of the `Recipe`
	`osid.id.Id`	`fromCookbookId`	the `Id` of the current `Cookbook`
	`osid.id.Id`	`toCookbookId`	the `Id` of the destination `Cookbook`
Errors	ALREADY_EXISTS		`recipeId` already assigned to `toCookbookId`
	NOT_FOUND		`recipeId, fromCookbookId`, or `toCookbookId` not found or `recipeId` not mapped to `fromCookbookId`
	NULL_ARGUMENT		`recipeId, fromCookbookId`, or `toCookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.