OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.DirectionSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSubjugateableSearchOrder
Used Byosid.recipe.DirectionSearchSession
osid.recipe.DirectionSmartCookbookSession
Description

An interface for specifying the ordering of search results.

MethodorderByRecipe
Description

Orders the results by recipe.

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

Tests if a recipe search order is available.

Returnboolean true if a recipe search order is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetRecipeSearchOrder
Description

Gets the recipe search order.

Returnosid.recipe.RecipeSearchOrder the recipe search order
ErrorsILLEGAL_STATE supportsRecipeSearchOrder() is false
Compliancemandatory This method must be implemented.
MethodorderByEstimatedDuration
Description

Orders the results by the duration.

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

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

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