OSID - osid.bidding.BidForm Service Interface Definition

Interface	osid.bidding.BidForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.bidding.batch.BidBatchForm`
Used By	`osid.bidding.BidAdminSession`
Description	This is the form for creating and updating `Bids`.Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `BidAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getQuantityMetadata
Description	Gets the metadata for the quantity.
Return	`osid.Metadata`		metadata for the quantity
Compliance	`mandatory`		This method must be implemented.
Method	setQuantity
Description	Sets the quantity.
Parameters	`cardinal`	`quantity`	the new quantity
Errors	INVALID_ARGUMENT		`quantity` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearQuantity
Description	Removes the quantity.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMaximumBidMetadata
Description	Gets the metadata for the maximum bid.
Return	`osid.Metadata`		metadata for the maximum bid
Compliance	`mandatory`		This method must be implemented.
Method	setMaximumBid
Description	Sets the maximum bid.
Parameters	`osid.financials.Currency`	`bid`	the new maximum bid
Errors	INVALID_ARGUMENT		`bid` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`bid` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearMaximumBid
Description	Removes the maximum bid.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getBidFormRecord
Description	Gets the `BidFormRecord` corresponding to the given bid record `Type`.
Parameters	`osid.type.Type`	`bidRecordType`	a bid record type
Return	`osid.bidding.records.BidFormRecord`		the bid form record
Errors	NULL_ARGUMENT		`bidRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(bidRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.