org.osid.bidding

Interface AuctionForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidGovernatorForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSourceableForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

AuctionBatchForm

public interface AuctionForm
extends OsidGovernatorForm, OsidTemporalForm

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 Summary

Methods

Modifier and Type	Method and Description
void	clearBuyoutPrice() Removes the buyout price.
void	clearCurrencyType() Removes the currency type.
void	clearItem() Removes the item.
void	clearItemLimit() Removes the item limit.
void	clearLotSize() Removes the lot size.
void	clearMinimumBidders() Removes the minimum bidders.
void	clearPriceIncrement() Removes the price increment.
void	clearReservePrice() Removes the reserve price.
void	clearSealed() Removes the sealed flag.
void	clearSeller() Removes the item.
void	clearStartingPrice() Removes the starting price.
AuctionFormRecord	getAuctionFormRecord(Type auctionRecordType) Gets the AuctionFormRecord corresponding to the given auction record Type.
Metadata	getBuyoutPriceMetadata() Gets the metadata for the buyout price.
Metadata	getCurrnecyTypeMetadata() Gets the metadata for the currency type.
Metadata	getItemLimitMetadata() Gets the metadata for the item limit.
Metadata	getItemMetadata() Gets the metadata for the item.
Metadata	getLotSizeMetadata() Gets the metadata for the lot size.
Metadata	getMinimumBiddersMetadata() Gets the metadata for the minimum bidders.
Metadata	getPriceIncrementMetadata() Gets the metadata for the price increment.
Metadata	getReservePriceMetadata() Gets the metadata for the reserve price.
Metadata	getSealedMetadata() Gets the metadata for the sealed flag.
Metadata	getSellerMetadata() Gets the metadata for the seller.
Metadata	getStartingPriceMetadata() Gets the metadata for the starting price.
void	setBuyoutPrice(Currency price) Sets the buyout price.
void	setCurrencyType(Type currencyType) Sets the currency type
void	setItem(Id resourceId) Sets the item.
void	setItemLimit(long limit) Sets the item limit.
void	setLotSize(long size) Sets the lot size.
void	setMinimumBidders(long bidders) Sets the minimum bidders.
void	setPriceIncrement(Currency price) Sets the price increment.
void	setReservePrice(Currency price) Sets the reserve price.
void	setSealed(boolean sealed) Sets the sealed flag.
void	setSeller(Id resourceId) Sets the seller.
void	setStartingPrice(Currency price) Sets the starting price.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getCurrnecyTypeMetadata

Metadata getCurrnecyTypeMetadata()

Gets the metadata for the currency type.

Returns:

metadata for the currency type

Compliance:

mandatory - This method must be implemented.

setCurrencyType

void setCurrencyType(Type currencyType)

Sets the currency type

Parameters:

currencyType - the new currency type

Throws:

InvalidArgumentException - currencyType is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - currencyType is null

Compliance:

mandatory - This method must be implemented.

clearCurrencyType

void clearCurrencyType()

Removes the currency type.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getMinimumBiddersMetadata

Metadata getMinimumBiddersMetadata()

Gets the metadata for the minimum bidders.

Returns:

metadata for the minimum bidders

Compliance:

mandatory - This method must be implemented.

setMinimumBidders

void setMinimumBidders(long bidders)

Sets the minimum bidders.

Parameters:

bidders - the new minimum bidders

Throws:

InvalidArgumentException - bidders is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearMinimumBidders

void clearMinimumBidders()

Removes the minimum bidders.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getSealedMetadata

Metadata getSealedMetadata()

Gets the metadata for the sealed flag.

Returns:

metadata for the sealed flag

Compliance:

mandatory - This method must be implemented.

setSealed

void setSealed(boolean sealed)

Sets the sealed flag.

Parameters:

sealed - the new sealed flag

Throws:

InvalidArgumentException - sealed is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearSealed

void clearSealed()

Removes the sealed flag.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getSellerMetadata

Metadata getSellerMetadata()

Gets the metadata for the seller.

Returns:

metadata for the seller

Compliance:

mandatory - This method must be implemented.

setSeller

void setSeller(Id resourceId)

Sets the seller.

Parameters:

resourceId - the new resource Id

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearSeller

void clearSeller()

Removes the item.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getItemMetadata

Metadata getItemMetadata()

Gets the metadata for the item.

Returns:

metadata for the item

Compliance:

mandatory - This method must be implemented.

setItem

void setItem(Id resourceId)

Sets the item.

Parameters:

resourceId - the new resource Id

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearItem

void clearItem()

Removes the item.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getLotSizeMetadata

Metadata getLotSizeMetadata()

Gets the metadata for the lot size.

Returns:

metadata for the lot size

Compliance:

mandatory - This method must be implemented.

setLotSize

void setLotSize(long size)

Sets the lot size.

Parameters:

size - the new lot size

Throws:

InvalidArgumentException - size is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearLotSize

void clearLotSize()

Removes the lot size.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getItemLimitMetadata

Metadata getItemLimitMetadata()

Gets the metadata for the item limit.

Returns:

metadata for the item limit

Compliance:

mandatory - This method must be implemented.

setItemLimit

void setItemLimit(long limit)

Sets the item limit.

Parameters:

limit - the new item limit

Throws:

InvalidArgumentException - limit is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearItemLimit

void clearItemLimit()

Removes the item limit.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getStartingPriceMetadata

Metadata getStartingPriceMetadata()

Gets the metadata for the starting price.

Returns:

metadata for the starting price

Compliance:

mandatory - This method must be implemented.

setStartingPrice

void setStartingPrice(Currency price)

Sets the starting price.

Parameters:

price - the new starting price

Throws:

InvalidArgumentException - price is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - price is null

Compliance:

mandatory - This method must be implemented.

clearStartingPrice

void clearStartingPrice()

Removes the starting price.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getPriceIncrementMetadata

Metadata getPriceIncrementMetadata()

Gets the metadata for the price increment.

Returns:

metadata for the price increment

Compliance:

mandatory - This method must be implemented.

setPriceIncrement

void setPriceIncrement(Currency price)

Sets the price increment.

Parameters:

price - the new price increment

Throws:

InvalidArgumentException - price is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - price is null

Compliance:

mandatory - This method must be implemented.

clearPriceIncrement

void clearPriceIncrement()

Removes the price increment.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getReservePriceMetadata

Metadata getReservePriceMetadata()

Gets the metadata for the reserve price.

Returns:

metadata for the reserve price

Compliance:

mandatory - This method must be implemented.

setReservePrice

void setReservePrice(Currency price)

Sets the reserve price.

Parameters:

price - the new reserve price

Throws:

InvalidArgumentException - price is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - price is null

Compliance:

mandatory - This method must be implemented.

clearReservePrice

void clearReservePrice()

Removes the reserve price.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getBuyoutPriceMetadata

Metadata getBuyoutPriceMetadata()

Gets the metadata for the buyout price.

Returns:

metadata for the buyout price

Compliance:

mandatory - This method must be implemented.

setBuyoutPrice

void setBuyoutPrice(Currency price)

Sets the buyout price.

Parameters:

price - the new buyout price

Throws:

InvalidArgumentException - price is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - price is null

Compliance:

mandatory - This method must be implemented.

clearBuyoutPrice

void clearBuyoutPrice()

Removes the buyout price.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getAuctionFormRecord

AuctionFormRecord getAuctionFormRecord(Type auctionRecordType)
                                       throws OperationFailedException

Gets the AuctionFormRecord corresponding to the given auction record Type.

Parameters:

auctionRecordType - an auction record type

Returns:

the auction form record

Throws:

NullArgumentException - auctionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionRecordType) is false

Compliance:

mandatory - This method must be implemented.