Interface AuctionBatchForm

All Superinterfaces:

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

public interface AuctionBatchForm
extends AuctionForm

This is the form for creating and updating auctions in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AuctionBatchAdminSession . For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Modifier and Type	Method	Description
Id	getAuctionId()	Gets the Id of the auction to be updated if this is an update transaction.

Methods inherited from interface AuctionForm

clearBuyoutPrice, clearCurrencyType, clearItem, clearItemLimit, clearLotSize, clearMinimumBidders, clearPriceIncrement, clearReservePrice, clearSealed, clearSeller, clearStartingPrice, getAuctionFormRecord, getBuyoutPriceMetadata, getCurrnecyTypeMetadata, getItemLimitMetadata, getItemMetadata, getLotSizeMetadata, getMinimumBiddersMetadata, getPriceIncrementMetadata, getReservePriceMetadata, getSealedMetadata, getSellerMetadata, getStartingPriceMetadata, setBuyoutPrice, setCurrencyType, setItem, setItemLimit, setLotSize, setMinimumBidders, setPriceIncrement, setReservePrice, setSealed, setSeller, setStartingPrice

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidSourceableForm

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

Modifier and Type	Method	Description
void	clearBranding()	Removes the branding.
void	clearLicense()	Removes the license.
void	clearProvider()	Removes the provider.
Metadata	getBrandingMetadata()	Gets the metadata for the asset branding.
Metadata	getLicenseMetadata()	Gets the metadata for the license.
Metadata	getProviderMetadata()	Gets the metadata for a provider.
void	setBranding(Id[] assetIds)	Sets the branding.
void	setLicense(String license)	Sets the license.
void	setProvider(Id providerId)	Sets a provider.

Method Details

getAuctionId

Id getAuctionId()

Gets the Id of the auction to be updated if this is an update transaction.

Returns:

the auction Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.