org.osid.bidding

Interface AuctionHouseForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

AuctionHouseBatchForm

public interface AuctionHouseForm
extends OsidCatalogForm

This is the form for creating and updating auction houses. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AuctionHouseAdminSession. 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
AuctionHouseFormRecord	getAuctionHouseFormRecord(Type auctionHouseRecordType) Gets the AuctionHouseFormRecord corresponding to the given auction house record Type.

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.OsidSourceableForm

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

Method Detail

getAuctionHouseFormRecord

AuctionHouseFormRecord getAuctionHouseFormRecord(Type auctionHouseRecordType)
                                                 throws OperationFailedException

Gets the AuctionHouseFormRecord corresponding to the given auction house record Type.

Parameters:

auctionHouseRecordType - an auction house record type

Returns:

the auction house form record

Throws:

NullArgumentException - auctionHouseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionHouseRecordType) is false

Compliance:

mandatory - This method must be implemented.