Interface | osid.recipe.RecipeCookbookAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignRecipes | ||
Description |
Tests if this user can alter recipe/cook book 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
| ||
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/cook book 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
| ||
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 cook books including and under the given cook book 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 cook book Ids | |
Errors | NULL_ARGUMENT | cookbookId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableCookbookIdsForRecipe | ||
Description |
Gets a list of cook books including and under the given cook book node in which a specific recipe can be assigned. | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
osid.id.Id | recipeId | the Id of the Recipe | |
Return | osid.id.IdList | list of assignable cook book Ids | |
Errors | NULL_ARGUMENT | cookbookId or recipeId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignRecipeToCookbook | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | recipeId | the Id of the Recipe |
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 | ||
Parameters | osid.id.Id | recipeId | the Id of the Recipe |
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. |