OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
recipe package
Version 3.0.0
Release Candidate Preview
| Interface | osid.recipe.DirectionQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| Description |
This is the query inspector for examining direction queries. | ||
| Method | getRecipeIdTerms | ||
| Description |
Gets the recipe | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecipeTerms | ||
| Description |
Gets the recipe query terms. | ||
| Return | osid.recipe.RecipeQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcedureIdTerms | ||
| Description |
Gets the procedure query terms. | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcedureTerms | ||
| Description |
Gets the procedure query terms. | ||
| Return | osid.recipe.ProcedureQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIngredientIdTerms | ||
| Description |
Gets the ingredient query terms. | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIngredientTerms | ||
| Description |
Gets the ingredient query terms. | ||
| Return | osid.recipe.IngredientQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEstimatedDurationTerms | ||
| 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 | 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 | getDirectionQueryInspectorRecord | ||
| Description |
Gets the direction query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | directionRecordType | a direction record type |
| Return | osid.recipe.records.DirectionQueryInspectorRecord | the direction query inspector 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. | |