OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
recipe package
Version 3.0.0
Release Candidate Preview
| Interface | osid.recipe.RecipeQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidSourceableQueryInspector | |||
| Description |
This is the query inspector for examining recipe queries. | ||
| Method | getTotalEstimatedDurationTerms | ||
| Description |
Gets the estimated duration query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetIdTerms | ||
| Description |
Gets the asset query terms. | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetTerms | ||
| Description |
Gets the asset query terms. | ||
| Return | osid.repository.AssetQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDirectionIdTerms | ||
| Description |
Gets the direction | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDirectionTerms | ||
| Description |
Gets the direction query terms. | ||
| Return | osid.recipe.DirectionQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTotalDurationTerms | ||
| Description |
Gets the total duration query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCookbookIdTerms | ||
| Description |
Gets the cook book | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCookbookTerms | ||
| Description |
Gets the cook book query terms. | ||
| Return | osid.recipe.CookbookQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecipeQueryInspectorRecord | ||
| Description |
Gets the recipe query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | recipeRecordType | a recipe record type |
| Return | osid.recipe.records.RecipeQueryInspectorRecord | the recipe query inspector 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. | |