OSID - osid.ordering.PriceForm Service Interface Definition

Interface	osid.ordering.PriceForm
Implements	`osid.OsidRuleForm`
Implements	`osid.OsidSubjugateableForm`
Used By	`osid.ordering.PriceScheduleAdminSession`
Description	This is the form for creating and updating `Prices`.Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `PriceAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getMinQuantityMetadata
Description	Gets the metadata for the minimum quantity.
Return	`osid.Metadata`		metadata for the minumim quantity
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumQuantity
Description	Sets the minimum quantity.
Parameters	`cardinal`	`minQuantity`	the new minumim quantity
Errors	INVALID_ARGUMENT		`minQuantity` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumQuantity
Description	Clears the minimum quantity.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMaxQuantityMetadata
Description	Gets the metadata for the minimum quantity.
Return	`osid.Metadata`		metadata for the maximum quantity
Compliance	`mandatory`		This method must be implemented.
Method	setMaximumQuantity
Description	Sets the maximum quantity.
Parameters	`cardinal`	`minQuantity`	the new maximum quantity
Errors	INVALID_ARGUMENT		`maxQuantity` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMaximumQuantity
Description	Clears the maximum quantity.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicMetadata
Description	Gets the metadata for the demographic.
Return	`osid.Metadata`		metadata for the demographic
Compliance	`mandatory`		This method must be implemented.
Method	setDemographic
Description	Sets the demographic.
Parameters	`osid.id.Id`	`resourceId`	the new demographic
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	clearDemographic
Description	Clears the demographic.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAmountMetadata
Description	Gets the metadata for the amount.
Return	`osid.Metadata`		metadata for the amount
Compliance	`mandatory`		This method must be implemented.
Method	setAmount
Description	Sets the amount.
Parameters	`osid.search.terms.CurrencyRangeTerm[]`	`amount`	the new amount
Errors	INVALID_ARGUMENT		`amount` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearAmount
Description	Clears the amount.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringIntervalMetadata
Description	Gets the metadata for the recurring interval.
Return	`osid.Metadata`		metadata for the recurring interval
Compliance	`mandatory`		This method must be implemented.
Method	setRecurringInterval
Description	Sets the recurring interval.
Parameters	`osid.calendaring.Duration`	`interval`	the new recurring interval
Errors	INVALID_ARGUMENT		`interval` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearRecurringInterval
Description	Clears the recurring interval.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPriceFormRecord
Description	Gets the `PriceFormRecord` corresponding to the given price record `Type`.
Parameters	`osid.type.Type`	`priceRecordType`	the price record type
Return	`osid.ordering.records.PriceFormRecord`		the price form record
Errors	NULL_ARGUMENT		`priceRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(priceRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.