OSID - osid.inventory.InventoryForm Service Interface Definition

Interface	osid.inventory.InventoryForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidSubjugateableForm`
Implemented By	`osid.inventory.batch.InventoryBatchForm`
Used By	`osid.inventory.InventoryAdminSession`
Description	This is the form for creating and updating `Inventories`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `InventoryAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getDateMetadata
Description	Gets the metadata for the date.
Return	`osid.Metadata`		metadata for the date
Compliance	`mandatory`		This method must be implemented.
Method	setDate
Description	Sets the date.
Parameters	`osid.calendaring.DateTime`	`date`	the new date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDate
Description	Removes the date.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
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	`decimal`	`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	getInventoryFormRecord
Description	Gets the `InventoryFormRecord` corresponding to the given inventory record `Type`.
Parameters	`osid.type.Type`	`inventoryRecordType`	an inventory record type
Return	`osid.inventory.records.InventoryFormRecord`		the inventory form record
Errors	NULL_ARGUMENT		`inventoryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(inventoryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.