Interface | osid.recipe.DirectionSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByRecipe | ||
Description |
Orders the results by recipe. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipeSearchOrder | ||
Description |
Tests if a recipe search order is available. | ||
Return | boolean | true if a recipe search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecipeSearchOrder | ||
Description |
Gets the recipe search order. | ||
Return | osid.recipe.RecipeSearchOrder | the recipe search order | |
Errors | ILLEGAL_STATE | supportsRecipeSearchOrder() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByEstimatedDuration | ||
Description |
Orders the results by the duration. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionSearchOrderRecord | ||
Description |
Gets the direction search order record corresponding to
the given direction record | ||
Parameters | osid.type.Type | directionRecordType | a direction record type |
Return | osid.recipe.records.DirectionSearchOrderRecord | the direction search order record | |
Errors | NULL_ARGUMENT | directionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(directionRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |