Interface | osid.recipe.RecipeCookbookSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupRecipeCookbookMappings | ||
Description |
Tests if this user can perform lookups of recipe/cook
book ingredients. A return of true does not guarantee
successful authorization. A return of false indicates that
it is known lookup methods in this session will result in
a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeRecipeCookbookView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryRecipeCookbookView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRecipeIdsByCookbook | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | cookbookId | Id of the Cookbook |
Return | osid.id.IdList | list of related recipe Ids | |
Errors | NOT_FOUND | cookbookId is not found | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRecipesByCookbook | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | cookbookId | Id of the Cookbook |
Return | osid.recipe.RecipeList | list of related recipes | |
Errors | NOT_FOUND | cookbookId is not found | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRecipeIdsByCookbooks | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | cookbookIds | list of cook book Ids |
Return | osid.id.IdList | list of recipe Ids | |
Errors | NULL_ARGUMENT | cookbookIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRecipesByCookbooks | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | cookbookIds | list of cook book Ids |
Return | osid.recipe.RecipeList | list of recipes | |
Errors | NULL_ARGUMENT | cookbookIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCookbookIdsByRecipe | ||
Description |
Gets the | ||
Parameters | osid.id.Id | recipeId | Id of a Recipe |
Return | osid.id.IdList | list of cook books | |
Errors | NOT_FOUND | recipeId is 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 | getCookbooksByRecipe | ||
Description |
Gets the | ||
Parameters | osid.id.Id | recipeId | Id of a Recipe |
Return | osid.recipe.CookbookList | list of cook books | |
Errors | NOT_FOUND | recipeId is not found | |
NULL_ARGUMENT | recipeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |