org.osid.bidding

Interface AuctionHouseSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface AuctionHouseSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AuctionHouseSearchOrderRecord	getAuctionHouseSearchOrderRecord(Type auctionHouseRecordType) Gets the auction house search order record corresponding to the given auction house Type.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getAuctionHouseSearchOrderRecord

AuctionHouseSearchOrderRecord getAuctionHouseSearchOrderRecord(Type auctionHouseRecordType)
                                                               throws OperationFailedException

Gets the auction house search order record corresponding to the given auction house Type. Multiple retrievals return the same underlying object.

Parameters:

auctionHouseRecordType - an auction house record type

Returns:

the auction house search order record

Throws:

NullArgumentException - auctionHouseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionHouseRecordType) is false

Compliance:

mandatory - This method must be implemented.