OSID - osid.bidding.AuctionForm Service Interface Definition

Interface	osid.bidding.AuctionForm
Implements	`osid.OsidGovernatorForm`
Implemented By	`osid.bidding.batch.AuctionBatchForm`
Used By	`osid.bidding.AuctionAdminSession`
Description	This is the form for creating and updating `Auctions`.Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `AuctionAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getCurrnecyTypeMetadata
Description	Gets the metadata for the currency type.
Return	`osid.Metadata`		metadata for the currency type
Compliance	`mandatory`		This method must be implemented.
Method	setCurrencyType
Description	Sets the currency type
Parameters	`osid.type.Type`	`currencyType`	the new currency type
Errors	INVALID_ARGUMENT		`currencyType` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`currencyType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCurrencyType
Description	Removes the currency type.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumBiddersMetadata
Description	Gets the metadata for the minimum bidders.
Return	`osid.Metadata`		metadata for the minimum bidders
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumBidders
Description	Sets the minimum bidders.
Parameters	`cardinal`	`bidders`	the new minimum bidders
Errors	INVALID_ARGUMENT		`bidders` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumBidders
Description	Removes the minimum bidders.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSealedMetadata
Description	Gets the metadata for the sealed flag.
Return	`osid.Metadata`		metadata for the sealed flag
Compliance	`mandatory`		This method must be implemented.
Method	setSealed
Description	Sets the sealed flag.
Parameters	`boolean`	`sealed`	the new sealed flag
Errors	INVALID_ARGUMENT		`sealed` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearSealed
Description	Removes the sealed flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSellerMetadata
Description	Gets the metadata for the seller.
Return	`osid.Metadata`		metadata for the seller
Compliance	`mandatory`		This method must be implemented.
Method	setSeller
Description	Sets the seller.
Parameters	`osid.id.Id`	`resourceId`	the new resource `Id`
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	clearSeller
Description	Removes the item.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getItemMetadata
Description	Gets the metadata for the item.
Return	`osid.Metadata`		metadata for the item
Compliance	`mandatory`		This method must be implemented.
Method	setItem
Description	Sets the item.
Parameters	`osid.id.Id`	`resourceId`	the new resource `Id`
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	clearItem
Description	Removes the item.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLotSizeMetadata
Description	Gets the metadata for the lot size.
Return	`osid.Metadata`		metadata for the lot size
Compliance	`mandatory`		This method must be implemented.
Method	setLotSize
Description	Sets the lot size.
Parameters	`cardinal`	`size`	the new lot size
Errors	INVALID_ARGUMENT		`size` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearLotSize
Description	Removes the lot size.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getItemLimitMetadata
Description	Gets the metadata for the item limit.
Return	`osid.Metadata`		metadata for the item limit
Compliance	`mandatory`		This method must be implemented.
Method	setItemLimit
Description	Sets the item limit.
Parameters	`cardinal`	`limit`	the new item limit
Errors	INVALID_ARGUMENT		`limit` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearItemLimit
Description	Removes the item limit.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getStartingPriceMetadata
Description	Gets the metadata for the starting price.
Return	`osid.Metadata`		metadata for the starting price
Compliance	`mandatory`		This method must be implemented.
Method	setStartingPrice
Description	Sets the starting price.
Parameters	`osid.financials.Currency`	`price`	the new starting price
Errors	INVALID_ARGUMENT		`price` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`price` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStartingPrice
Description	Removes the starting price.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPriceIncrementMetadata
Description	Gets the metadata for the price increment.
Return	`osid.Metadata`		metadata for the price increment
Compliance	`mandatory`		This method must be implemented.
Method	setPriceIncrement
Description	Sets the price increment.
Parameters	`osid.financials.Currency`	`price`	the new price increment
Errors	INVALID_ARGUMENT		`price` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`price` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPriceIncrement
Description	Removes the price increment.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getReservePriceMetadata
Description	Gets the metadata for the reserve price.
Return	`osid.Metadata`		metadata for the reserve price
Compliance	`mandatory`		This method must be implemented.
Method	setReservePrice
Description	Sets the reserve price.
Parameters	`osid.financials.Currency`	`price`	the new reserve price
Errors	INVALID_ARGUMENT		`price` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`price` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearReservePrice
Description	Removes the reserve price.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getBuyoutPriceMetadata
Description	Gets the metadata for the buyout price.
Return	`osid.Metadata`		metadata for the buyout price
Compliance	`mandatory`		This method must be implemented.
Method	setBuyoutPrice
Description	Sets the buyout price.
Parameters	`osid.financials.Currency`	`price`	the new buyout price
Errors	INVALID_ARGUMENT		`price` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`price` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBuyoutPrice
Description	Removes the buyout price.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionFormRecord
Description	Gets the `AuctionFormRecord` corresponding to the given auction record `Type`.
Parameters	`osid.type.Type`	`auctionRecordType`	an auction record type
Return	`osid.bidding.records.AuctionFormRecord`		the auction form record
Errors	NULL_ARGUMENT		`auctionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(auctionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.