OSID - osid.recipe.RecipeAdminSession Service Interface Definition

Interface	osid.recipe.RecipeAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Recipes.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Recipe,` a `RecipeForm` is requested using `getRecipeFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `RecipeForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `RecipeForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RecipeForm` corresponds to an attempted transaction. For updates, `RecipeForms` are requested to the `Recipe` `Id` that is to be updated using `getRecipeFormForUpdate().` Similarly, the `RecipeForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RecipeForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Recipes.` To unmap a `Recipe` from the current `Cookbook,` the `RecipeCookbookAssignmentSession` should be used. These delete operations attempt to remove the `Recipe` itself thus removing it from all known `Cookbook` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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	canCreateRecipes
Description	Tests if this user can create `Recipes.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Recipe` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Recipe` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRecipeWithRecordTypes
Description	Tests if this user can create a single `Recipe` using the desired record types. While `RecipeManager.getRecipeRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Recipe.` Providing an empty array tests if a `Recipe` can be created with no records.
Parameters	`osid.type.Type[]`	`recipeRecordTypes`	array of recipe record types
Return	`boolean`		`true` if `Recipe` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`recipeRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRecipeFormForCreate
Description	Gets the recipe form for creating new recipes. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`recipeRecordTypes`	array of recipe record types
Return	`osid.recipe.RecipeForm`		the recipe form
Errors	NULL_ARGUMENT		`recipeRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createRecipe
Description	Creates a new `Recipe.`
Parameters	`osid.recipe.RecipeForm`	`recipeForm`	the form for this `Recipe`
Return	`osid.recipe.Recipe`		the new `Recipe`
Errors	ILLEGAL_STATE		`recipeForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`recipeForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`recipeForm` did not originate from `getRecipeFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRecipes
Description	Tests if this user can update `Recipes.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Recipe` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Recipe` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRecipeFormForUpdate
Description	Gets the recipe form for updating an existing recipe. A new recipe form should be requested for each update transaction.
Parameters	`osid.id.Id`	`recipeId`	the `Id` of the `Recipe`
Return	`osid.recipe.RecipeForm`		the recipe form
Errors	NOT_FOUND		`recipeId` is not found
	NULL_ARGUMENT		`recipeId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updateRecipe
Description	Updates an existing recipe.
Parameters	`osid.recipe.RecipeForm`	`recipeForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`recipeForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`recipeId` or `recipeForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`recipeForm` did not originate from `getRecipeFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRecipes
Description	Tests if this user can delete `Recipes.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Recipe` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Recipe` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRecipe
Description	Deletes a `Recipe.`
Parameters	`osid.id.Id`	`recipeId`	the `Id` of the `Recipe` to remove
Errors	NOT_FOUND		`recipeId` not found
	NULL_ARGUMENT		`recipeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRecipeAliases
Description	Tests if this user can manage `Id` aliases for `Recipes.` A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Recipe` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRecipe
Description	Adds an `Id` to a `Recipe` for the purpose of creating compatibility. The primary `Id` of the `Recipe` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another recipe, it is reassigned to the given recipe `Id.`
Parameters	`osid.id.Id`	`recipeId`	the `Id` of a `Recipe`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`recipeId` not found
	NULL_ARGUMENT		`recipeId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.