OSID - osid.recipe.IngredientForm Service Interface Definition

Interface	osid.recipe.IngredientForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidSubjugateableForm`
Implemented By	`osid.recipe.batch.IngredientBatchForm`
Used By	`osid.recipe.DirectionAdminSession`
Description	This is the form for creating and updating `Ingredients`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `DirectionAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getQuantityMetadata
Description	Gets the metadata for the quantity.
Return	`osid.Metadata`		metadata for the quantity
Compliance	`mandatory`		This method must be implemented.
Method	setQuantity
Description	Sets the quantity.
Parameters	`cardinal`	`quantity`	the new quantity
Errors	INVALID_ARGUMENT		`quantity` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearQuantity
Description	Removes the quantity.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getUnitTypeMetadata
Description	Gets the metadata for the unit type.
Return	`osid.Metadata`		metadata for the unit type
Compliance	`mandatory`		This method must be implemented.
Method	setUnitType
Description	Sets the unit type.
Parameters	`osid.type.Type`	`unitType`	the new unit type
Errors	INVALID_ARGUMENT		`unitType` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`unitType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearUnitType
Description	Removes the unit type.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getStockMetadata
Description	Gets the metadata for the stock.
Return	`osid.Metadata`		metadata for the stock
Compliance	`mandatory`		This method must be implemented.
Method	setStock
Description	Sets the stock.
Parameters	`osid.id.Id`	`stockId`	the new stock
Errors	INVALID_ARGUMENT		`stockId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`stockId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStock
Description	Removes the stock.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIngredientFormRecord
Description	Gets the `IngredientFormRecord` corresponding to the given ingredient record `Type`.
Parameters	`osid.type.Type`	`ingredientRecordType`	an ingredient record type
Return	`osid.recipe.records.IngredientFormRecord`		the ingredient form 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.