OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
recipe package
Version 3.0.0
Release Candidate Preview
| Interface | osid.recipe.RecipeSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSourceableSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByTotalEstimatedDuration | ||
| Description |
Orders the results by total estimated duration. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecipeSearchOrderRecord | ||
| Description |
Gets the recipe search order record corresponding to
the given recipe record | ||
| Parameters | osid.type.Type | recipeRecordType | a recipe record type |
| Return | osid.recipe.records.RecipeSearchOrderRecord | the recipe search order record | |
| Errors | NULL_ARGUMENT | recipeRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(recipeRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |