OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.RecipeSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetRecipes
Description

Gets the recipe list resulting from a search.

Returnosid.recipe.RecipeListthe recipe list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRecipeQueryInspector
Description

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

Returnosid.recipe.RecipeQueryInspectorthe recipe query inspector
CompliancemandatoryThis 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.TyperecipeSearchRecordTypea recipe search record type
Returnosid.recipe.records.RecipeSearchResultsRecordthe recipe search results 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.