Interface | osid.recipe.RecipeQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Recipes may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getCookbookId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Cookbook Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCookbook | ||
Description |
Gets the | ||
Return | osid.recipe.Cookbook | the cookbook | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchRecipes | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search 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 cook book which are children of this cook book in the cook book hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCookbookView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts searches to this cook book only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRecipeQuery | ||
Description |
Gets a recipe query. | ||
Return | osid.recipe.RecipeQuery | the recipe query | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecipesByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.recipe.RecipeQuery | recipeQuery | the recipe query |
Return | osid.recipe.RecipeList | the returned RecipeList | |
Errors | NULL_ARGUMENT | recipeQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | recipeQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |