| Interface | osid.recipe.Ingredient | ||
|---|---|---|---|
| Implements | osid.OsidObject | ||
osid.Subjugateable | |||
| Description |
An | ||
| Method | getQuantity | ||
| Description |
Gets the quantity of items. | ||
| Return | decimal | the quantity | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getUnitType | ||
| Description |
Gets the units of the quantity. | ||
| Return | osid.type.Type | the unit type | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStockId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the stock Id | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStock | ||
| Description |
Get the stock. | ||
| Return | osid.inventory.Stock | the stock | |
| Errors | OPERATION_FAILED | unable to complete request | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIngredientRecord | ||
| Description |
Gets the ingredient record corresponding to the given
| ||
| Parameters | osid.type.Type | ingredientRecordType | the type of ingredient record to retrieve |
| Return | osid.recipe.records.IngredientRecord | the ingredient 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. | |