Interface | osid.recipe.RecipeSearchSession | ||
---|---|---|---|
Implements | osid.recipe.RecipeQuerySession | ||
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 | getRecipeSearch | ||
Description |
Gets a recipe search. | ||
Return | osid.recipe.RecipeSearch | the recipe search | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecipeSearchOrder | ||
Description |
Gets a recipe search order. The | ||
Return | osid.recipe.RecipeSearchOrder | the recipe search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecipesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.recipe.RecipeQuery | recipeQuery | the recipe query |
osid.recipe.RecipeSearch | recipeSearch | the recipe search | |
Return | osid.recipe.RecipeSearchResults | the recipe search results | |
Errors | NULL_ARGUMENT | recipeQuery or recipeSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | recipeQuery or recipeSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRecipeQueryFromInspector | ||
Description |
Gets a recipe query from an inspector. The inspector is
available from a | ||
Parameters | osid.recipe.RecipeQueryInspector | recipeQueryInspector | a recipe query inspector |
Return | osid.recipe.RecipeQuery | the recipe query | |
Errors | NULL_ARGUMENT | recipeQueryInspector is null | |
UNSUPPORTED | recipeQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |