OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.RecipeSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSourceableSearchOrder
Used Byosid.recipe.DirectionSearchOrder
osid.recipe.RecipeSearchSession
osid.recipe.RecipeSmartCookbookSession
Description

An interface for specifying the ordering of search results.

MethodorderByTotalEstimatedDuration
Description

Orders the results by total estimated duration.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodgetRecipeSearchOrderRecord
Description

Gets the recipe search order record corresponding to the given recipe record Type. Multiple retrievals return the same underlying object.

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