OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.RecipeSearch
Implementsosid.OsidSearch
Used Byosid.recipe.RecipeSearchSession
Description

The search interface for governing recipe searches.

MethodsearchAmongRecipes
Description

Execute this search among the given list of recipes.

Parametersosid.id.IdListrecipeIds list of recipes
ErrorsNULL_ARGUMENT recipeIds is null
Compliancemandatory This method must be implemented.
MethodorderRecipeResults
Description

Specify an ordering to the search results.

Parametersosid.recipe.RecipeSearchOrderrecipeSearchOrder recipe search order
ErrorsNULL_ARGUMENT recipeSearchOrder is null
UNSUPPORTED recipeSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetRecipeSearchRecord
Description

Gets the recipe search record corresponding to the given recipe search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TyperecipeSearchRecordType a recipe search record type
Returnosid.recipe.records.RecipeSearchRecord the recipe search record
ErrorsNULL_ARGUMENT recipeSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(recipeSearchRecordType) is false
Compliancemandatory This method must be implemented.