public interface AuctionHouseSearch extends OsidSearch
The search interface for governing auction house searches.
Modifier and Type | Method and Description |
---|---|
AuctionHouseSearchRecord |
getAuctionHouseSearchRecord(Type auctionHouseSearchRecordType)
Gets the auction house search record corresponding to the given
auction house search record
Type. |
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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongAuctionHouses(IdList auctionHouseIds)
auctionHouseIds
- list of auction housesNullArgumentException
- auctionHouseIds
is null
mandatory
- This method must be implemented. void orderAuctionHouseResults(AuctionHouseSearchOrder auctionHouseSearchOrder)
auctionHouseSearchOrder
- auctionHouse search orderNullArgumentException
- auctionHouseSearchOrder
is null
UnsupportedException
- auctionHouseSearchOrder
is not of this servicemandatory
- This method must be implemented. AuctionHouseSearchRecord getAuctionHouseSearchRecord(Type auctionHouseSearchRecordType) throws OperationFailedException
Type.
This method is used
to retrieve an object implementing the requested record.auctionHouseSearchRecordType
- an auction house search record
typeNullArgumentException
-
auctionHouseSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(auctionHouseSearchRecordType)
is
false
mandatory
- This method must be implemented.