OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.RecipeSearch
Implementsosid.OsidSearch
Description

The search interface for governing recipe searches.

MethodsearchAmongRecipes
Description

Execute this search among the given list of recipes.

Parametersosid.id.IdListrecipeIdslist of recipes
ErrorsNULL_ARGUMENT recipeIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRecipeResults
Description

Specify an ordering to the search results.

Parametersosid.recipe.RecipeSearchOrderrecipeSearchOrderrecipe search order
ErrorsNULL_ARGUMENT recipeSearchOrder is null
UNSUPPORTED recipeSearchOrder is not of this service
CompliancemandatoryThis 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.TyperecipeSearchRecordTypea recipe search record type
Returnosid.recipe.records.RecipeSearchRecordthe recipe search record
ErrorsNULL_ARGUMENT recipeSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(recipeSearchRecordType) is false
CompliancemandatoryThis method must be implemented.