OSID - osid.ordering.PriceScheduleForm Service Interface Definition

Interface	osid.ordering.PriceScheduleForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidAggregateableForm`
Implemented By	`osid.ordering.batch.PriceScheduleBatchForm`
Used By	`osid.ordering.PriceScheduleAdminSession`
Description	This is the form for creating and updating `PriceSchedules`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `PriceScheduleAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints. Like all `OsidForms`, `PriceScheduleForm` is stateful and must not be accessed by multiple processing threads.
Method	getListPriceMetadata
Description	Gets the metadata for the list price.
Return	`osid.Metadata`		metadata for the list price
Compliance	`mandatory`		This method must be implemented.
Method	setListPrice
Description	Sets the list price.
Parameters	`osid.financials.Currency`	`listPrice`	the new list price
Errors	INVALID_ARGUMENT		`listPrice` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearListPrice
Description	Clears the list price.
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	getPriceScheduleFormRecord
Description	Gets the `PriceScheduleFormRecord` corresponding to the given price schedule record `Type`.
Parameters	`osid.type.Type`	`priceScheduleRecordType`	the price schedule record type
Return	`osid.ordering.records.PriceScheduleFormRecord`		the price schedule form record
Errors	NULL_ARGUMENT		`priceScheduleRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(priceScheduleRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.