OSID - osid.inventory.ItemForm Service Interface Definition

Interface	osid.inventory.ItemForm
Implements	`osid.OsidObjectForm`
Description	This is the form for creating and updating `Items.` Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `ItemAdminSession.` For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getStockMetadata
Description	Gets the metadata for stock.
Return	`osid.Metadata`		metadata for the stock
Compliance	`mandatory`		This method must be implemented.
Method	setStock
Description	Sets the stock `Id.`
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	getPropertyTagMetadata
Description	Gets the metadata for serial number.
Return	`osid.Metadata`		metadata for the serial number
Compliance	`mandatory`		This method must be implemented.
Method	setPropertyTag
Description	Sets the property tag.
Parameters	`string`	`property`	the new property tag
Errors	INVALID_ARGUMENT		`property` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`property` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPropertyTag
Description	Removes the property tag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSerialNumberMetadata
Description	Gets the metadata for serial number.
Return	`osid.Metadata`		metadata for the serial number
Compliance	`mandatory`		This method must be implemented.
Method	setSerialNumber
Description	Sets the serial number.
Parameters	`string`	`serial`	the new serial number
Errors	INVALID_ARGUMENT		`serial` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`serial` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSerialNumber
Description	Removes the serial number.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLocationDescriptionMetadata
Description	Gets the metadata for location description.
Return	`osid.Metadata`		metadata for the location description
Compliance	`mandatory`		This method must be implemented.
Method	setLocationDescription
Description	Sets the location description.
Parameters	`string`	`location`	the new location description
Errors	INVALID_ARGUMENT		`location` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`location` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationDescription
Description	Removes the location description.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLocationMetadata
Description	Gets the metadata for location.
Return	`osid.Metadata`		metadata for the location
Compliance	`mandatory`		This method must be implemented.
Method	setLocation
Description	Sets the location.
Parameters	`string`	`locationId`	the new location
Errors	INVALID_ARGUMENT		`locationId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`locationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLocation
Description	Removes the location.
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 the item.
Return	`osid.Metadata`		metadata for the locitemation
Compliance	`mandatory`		This method must be implemented.
Method	setItem
Description	Sets the item to which this item is a part.
Parameters	`osid.id.Id`	`itemId`	the new parent 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	getItemFormRecord
Description	Gets the `ItemFormRecord` corresponding to the given item record `Type.`
Parameters	`osid.type.Type`	`itemRecordType`	an item record type
Return	`osid.inventory.records.ItemFormRecord`		the item form record
Errors	NULL_ARGUMENT		`itemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(itemRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.