org.osid.bidding

Interface AuctionHouse

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface AuctionHouse
extends OsidCatalog

An AuctionHouse represents a collection of auctions.

Method Summary

Methods

Modifier and Type	Method and Description
AuctionHouseRecord	getAuctionHouseRecord(Type auctionHouseRecordType) Gets the auction house record corresponding to the given AuctionHouse record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getAuctionHouseRecord

AuctionHouseRecord getAuctionHouseRecord(Type auctionHouseRecordType)
                                         throws OperationFailedException

Gets the auction house record corresponding to the given AuctionHouse record Type. This method is used to retrieve an object implementing the requested record. The auctionHouseRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(auctionHouseRecordType) is true .

Parameters:

auctionHouseRecordType - the type of auction house record to retrieve

Returns:

the auction house record

Throws:

NullArgumentException - auctionHouseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionHouseRecordType) is false

Compliance:

mandatory - This method must be implemented.