OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.AuctionHouseSearch
Implementsosid.OsidSearch
Description

The search interface for governing auction house searches.

MethodsearchAmongAuctionHouses
Description

Execute this search among the given list of auction houses.

Parametersosid.id.IdListauctionHouseIdslist of auction houses
ErrorsNULL_ARGUMENT auctionHouseIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAuctionHouseResults
Description

Specify an ordering to the search results.

Parametersosid.bidding.AuctionHouseSearchOrderauctionHouseSearchOrderauctionHouse search order
ErrorsNULL_ARGUMENT auctionHouseSearchOrder is null
UNSUPPORTED auctionHouseSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseSearchRecord
Description

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.

Parametersosid.type.TypeauctionHouseSearchRecordTypean auction house search record type
Returnosid.bidding.records.AuctionHouseSearchRecordthe auction house search record
ErrorsNULL_ARGUMENT auctionHouseSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(auctionHouseSearchRecordType) is false
CompliancemandatoryThis method must be implemented.