Interface | osid.recipe.RecipeSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing recipe searches. | ||
Method | searchAmongRecipes | ||
Description |
Execute this search among the given list of recipes. | ||
Parameters | osid.id.IdList | recipeIds | list of recipes |
Errors | NULL_ARGUMENT | recipeIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderRecipeResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.recipe.RecipeSearchOrder | recipeSearchOrder | recipe search order |
Errors | NULL_ARGUMENT | recipeSearchOrder is null | |
UNSUPPORTED | recipeSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRecipeSearchRecord | ||
Description |
Gets the recipe search record corresponding to the
given recipe search record | ||
Parameters | osid.type.Type | recipeSearchRecordType | a recipe search record type |
Return | osid.recipe.records.RecipeSearchRecord | the recipe search record | |
Errors | NULL_ARGUMENT | recipeSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(recipeSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |