OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.RecipeSearchSession
Implementsosid.recipe.RecipeQuerySession
Description

This session provides methods for searching among Recipe objects. The search query is constructed using the RecipeQuery.

getRecipesByQuery() is the basic search method and returns a list of Recipes. A more advanced search may be performed with getRecipesBySearch(). It accepts a RecipeSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRecipesBySearch() returns a RecipeSearchResults that can be used to access the resulting RecipeList or be used to perform a search within the result set through RecipeSearch.

This session defines views that offer differing behaviors for searching.

  • federated cook book view: searches include recipes in cook books of which this cook book is an ancestor in the cook book hierarchy
  • isolated cook book view: searches are restricted to recipes in this cook books

Recipes may have a query record indicated by their respective record types. The query record is accessed via the RecipeQuery.

MethodgetRecipeSearch
Description

Gets a recipe search.

Returnosid.recipe.RecipeSearchthe recipe search
CompliancemandatoryThis method must be implemented.
MethodgetRecipeSearchOrder
Description

Gets a recipe search order. The RecipeSearchOrder is supplied to a RecipeSearch to specify the ordering of results.

Returnosid.recipe.RecipeSearchOrderthe recipe search order
CompliancemandatoryThis method must be implemented.
MethodgetRecipesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.recipe.RecipeQueryrecipeQuerythe recipe query
osid.recipe.RecipeSearchrecipeSearchthe recipe search
Returnosid.recipe.RecipeSearchResultsthe recipe search results
ErrorsNULL_ARGUMENT recipeQuery or recipeSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED recipeQuery or recipeSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRecipeQueryFromInspector
Description

Gets a recipe query from an inspector. The inspector is available from a RecipeSearchResults.

Parametersosid.recipe.RecipeQueryInspectorrecipeQueryInspectora recipe query inspector
Returnosid.recipe.RecipeQuerythe recipe query
ErrorsNULL_ARGUMENT recipeQueryInspector is null
UNSUPPORTED recipeQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.