OSID - osid.ordering.ProductForm Service Interface Definition

Interface	osid.ordering.ProductForm
Implements	`osid.OsidObjectForm`
Implemented By	`osid.ordering.batch.ProductBatchForm`
Used By	`osid.ordering.ProductAdminSession`
Description	This is the form for creating and updating `Products`.Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `ProductAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getCodeMetadata
Description	Gets the metadata for the code.
Return	`osid.Metadata`		metadata for the code
Compliance	`mandatory`		This method must be implemented.
Method	setCode
Description	Sets the code.
Parameters	`string`	`code`	the new code
Errors	INVALID_ARGUMENT		`code` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`code` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCode
Description	Clears the code.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPriceSchedulesMetadata
Description	Gets the metadata for the price schedules.
Return	`osid.Metadata`		metadata for the price schedules
Compliance	`mandatory`		This method must be implemented.
Method	setPriceSchedules
Description	Sets the price schedules.
Parameters	`osid.id.Id[]`	`priceScheduleids`	the new price schedules
Errors	INVALID_ARGUMENT		`priceScheduleIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`priceScheduleIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPriceSchedules
Description	Clears the price schedules.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityMetadata
Description	Gets the metadata for the availability.
Return	`osid.Metadata`		metadata for the availability
Compliance	`mandatory`		This method must be implemented.
Method	setAvailability
Description	Sets the availability.
Parameters	`cardinal`	`availability`	the new availability
Errors	INVALID_ARGUMENT		`availability` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearAvailability
Description	Clears the availability.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProductFormRecord
Description	Gets the `ProductFormRecord` corresponding to the given product record `Type`.
Parameters	`osid.type.Type`	`productRecordType`	the product record type
Return	`osid.ordering.records.ProductFormRecord`		the product form record
Errors	NULL_ARGUMENT		`productRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(productRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.