Interface AuctionHouseSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AuctionHouseSearch
extends OsidSearch

The search interface for governing auction house searches.

Method Summary

Modifier and Type	Method	Description
AuctionHouseSearchRecord	getAuctionHouseSearchRecord(Type auctionHouseSearchRecordType)	Gets the auction house search record corresponding to the given auction house search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAuctionHouseResults(AuctionHouseSearchOrder auctionHouseSearchOrder)	Specify an ordering to the search results.
void	searchAmongAuctionHouses(IdList auctionHouseIds)	Execute this search among the given list of auction houses.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongAuctionHouses

void searchAmongAuctionHouses(IdList auctionHouseIds)

Execute this search among the given list of auction houses.

Parameters:

auctionHouseIds - list of auction houses

Throws:

NullArgumentException - auctionHouseIds is null

Compliance:

mandatory - This method must be implemented.

orderAuctionHouseResults

void orderAuctionHouseResults(AuctionHouseSearchOrder auctionHouseSearchOrder)

Specify an ordering to the search results.

Parameters:

auctionHouseSearchOrder - auctionHouse search order

Throws:

NullArgumentException - auctionHouseSearchOrder is null

UnsupportedException - auctionHouseSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAuctionHouseSearchRecord

AuctionHouseSearchRecord getAuctionHouseSearchRecord(Type auctionHouseSearchRecordType)
                                              throws OperationFailedException

Gets the auction house search record corresponding to the given auction house search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

auctionHouseSearchRecordType - an auction house search record type

Returns:

the auction house search record

Throws:

NullArgumentException - auctionHouseSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionHouseSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.