OSID - osid.inventory.ModelForm Service Interface Definition

Interface	osid.inventory.ModelForm
Implements	`osid.OsidObjectForm`
Implemented By	`osid.inventory.batch.ModelBatchForm`
Used By	`osid.inventory.ModelAdminSession`
Description	This is the form for creating and updating `Models`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `ModelAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getManufacturerMetadata
Description	Gets the metadata for the manufacturer.
Return	`osid.Metadata`		metadata for the manufacturer
Compliance	`mandatory`		This method must be implemented.
Method	setManufacturer
Description	Sets the manufacturer.
Parameters	`osid.id.Id`	`resourceId`	the new resource
Errors	INVALID_ARGUMENT		`resourceId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearManufacturer
Description	Removes the manufacturer.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getArchetypeMetadata
Description	Gets the metadata for the archetype.
Return	`osid.Metadata`		metadata for the archetype
Compliance	`mandatory`		This method must be implemented.
Method	setArchetype
Description	Sets the archetype.
Parameters	`string`	`archetype`	the new archetype
Errors	INVALID_ARGUMENT		`archetype` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`archetype` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearArchetype
Description	Removes the archetype.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getNumberMetadata
Description	Gets the metadata for the model number.
Return	`osid.Metadata`		metadata for the model number
Compliance	`mandatory`		This method must be implemented.
Method	setNumber
Description	Sets the model number.
Parameters	`string`	`number`	the new model number
Errors	INVALID_ARGUMENT		`number` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`number` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearNumber
Description	Removes the model number.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getModelFormRecord
Description	Gets the `ModelFormRecord` corresponding to the given model record `Type`.
Parameters	`osid.type.Type`	`modelRecordType`	a model record type
Return	`osid.inventory.records.ModelFormRecord`		the model form record
Errors	NULL_ARGUMENT		`modelRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(modelRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.