OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.DirectionSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSubjugateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByRecipe
Description

Orders the results by recipe.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodgetRecipeSearchOrder
Description

Gets the recipe search order.

Returnosid.recipe.RecipeSearchOrderthe recipe search order
ErrorsILLEGAL_STATE supportsRecipeSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByEstimatedDuration
Description

Orders the results by the duration.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis 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.TypedirectionRecordTypea direction record type
Returnosid.recipe.records.DirectionSearchOrderRecordthe direction search order record
ErrorsNULL_ARGUMENT directionRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(directionRecordType) is false
CompliancemandatoryThis method must be implemented.