OSID Specifications
recipe package
Version 3.0.0
recipe package
Version 3.0.0
| Interface | osid.recipe.IngredientQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| Used By | osid.recipe.DirectionQueryInspector | ||
| Description |
This is the query inspector for examining ingredient queries. | ||
| Method | getQuanityTerms | ||
| Description |
Gets the quantity query terms. | ||
| Return | osid.search.terms.CardinalRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getUnitTypeTerms | ||
| Description |
Gets the unit type query terms. | ||
| Return | osid.search.terms.TypeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStockIdTerms | ||
| Description |
Gets the stock query terms. | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStockTerms | ||
| Description |
Gets the stock query terms. | ||
| Return | osid.inventory.StockQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIngredientQueryInspectorRecord | ||
| Description |
Gets the ingredient query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | ingredientRecordType | an ingredient record type |
| Return | osid.recipe.records.IngredientQueryInspectorRecord | the ingredient query inspector record | |
| Errors | NULL_ARGUMENT | ingredientRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(ingredientRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |