OSID - osid.recipe.IngredientQuery Service Interface Definition

Interface	osid.recipe.IngredientQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.recipe.DirectionQuery`
Description	This is the query for searching ingredients. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchQuantity
Description	Matches ingredients with quantity between the given range inclusive.
Parameters	`cardinal`	`low`	starting of range
	`cardinal`	`high`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyQuantity
Description	Matches ingredients with any quantity.
Parameters	`boolean`	`match`	`true` to match ingredients with any quantity, `false` to match ingredients with no quantity
Compliance	`mandatory`		This method must be implemented.
Method	clearQuantityTerms
Description	Clears the quantity query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchUnitType
Description	Matches ingredients with a unit type.
Parameters	`osid.type.Type`	`unitType`	a unit type
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`unitType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyUnitType
Description	Matches ingredients with any unit type.
Parameters	`boolean`	`match`	`true` to match ingredients with any unit type, `false` to match ingredients with no unit type
Compliance	`mandatory`		This method must be implemented.
Method	clearUnitTypeTerms
Description	Clears the unit type query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStockId
Description	Sets the stock `Id` for this query.
Parameters	`osid.id.Id`	`stockId`	the stock `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`stockId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStockIdTerms
Description	Clears the stock `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockQuery
Description	Tests if a `StockQuery` is available.
Return	`boolean`		`true` if a stock query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStockQuery
Description	Gets the query for a stock. Multiple retrievals produce a nested `OR` term.
Return	`osid.inventory.StockQuery`		the stock query
Errors	UNIMPLEMENTED		`supportsStockQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockQuery()` is `true`.
Method	matchAnyStock
Description	Matches ingredients with any stock.
Parameters	`boolean`	`match`	`true` to match ingredients with any stock, `false` to match ingredients with no stock
Compliance	`mandatory`		This method must be implemented.
Method	clearStockTerms
Description	Clears the stock query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getIngredientQueryRecord
Description	Gets the ingredient query record corresponding to the given `Ingredient` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`ingredientRecordType`	an ingredient record type
Return	`osid.recipe.records.IngredientQueryRecord`		the ingredient query 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.