OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.RecipeSearchResults
Implementsosid.OsidSearchResults
Used Byosid.recipe.RecipeSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetRecipes
Description

Gets the recipe list resulting from a search.

Returnosid.recipe.RecipeList the recipe list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetRecipeQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.recipe.RecipeQueryInspector the recipe query inspector
Compliancemandatory This method must be implemented.
MethodgetRecipeSearchResultsRecord
Description

Gets the recipe search results 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.RecipeSearchResultsRecord the recipe search results 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.