Interface | osid.recipe.RecipeSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getRecipes | ||
Description |
Gets the recipe list resulting from a search. | ||
Return | osid.recipe.RecipeList | the recipe list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecipeQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.recipe.RecipeQueryInspector | the recipe query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecipeSearchResultsRecord | ||
Description |
Gets the recipe search results record corresponding to
the given recipe search record | ||
Parameters | osid.type.Type | recipeSearchRecordType | a recipe search record type |
Return | osid.recipe.records.RecipeSearchResultsRecord | the recipe search results 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. |