OSID - osid.inventory.shipment.EntryForm Service Interface Definition

Interface	osid.inventory.shipment.EntryForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidSubjugateableForm`
Implemented By	`osid.inventory.shipment.batch.EntryBatchForm`
Used By	`osid.inventory.shipment.ShipmentAdminSession`
Description	This is the form for creating and updating `Entries`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `EntryAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getModelMetadata
Description	Gets the metadata for a model.
Return	`osid.Metadata`		metadata for the model
Compliance	`mandatory`		This method must be implemented.
Method	setModel
Description	Sets the model.
Parameters	`osid.id.Id`	`modelId`	the new model
Errors	INVALID_ARGUMENT		`modelId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`modelId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearModel
Description	Removes the model.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getItemMetadata
Description	Gets the metadata for an item.
Return	`osid.Metadata`		metadata for the item
Compliance	`mandatory`		This method must be implemented.
Method	setItem
Description	Sets the item.
Parameters	`osid.id.Id`	`itemId`	the new item
Errors	INVALID_ARGUMENT		`itemId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`itemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearItem
Description	Removes the item.
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	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`	`type`	the new unit type
Errors	INVALID_ARGUMENT		`type` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`type` 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	getEntryFormRecord
Description	Gets the `EntryFormRecord` corresponding to the given entry record `Type`.
Parameters	`osid.type.Type`	`entryRecordType`	an entry record type
Return	`osid.inventory.shipment.records.EntryFormRecord`		the entry form record
Errors	NULL_ARGUMENT		`entryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(entryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.