OSID Logo
OSID Specifications
bidding package
Version 3.1.0
Interfaceosid.bidding.AuctionSearch
Implementsosid.OsidSearch
Used Byosid.bidding.AuctionSearchSession
Description

The search interface for governing auction searches.

MethodsearchAmongAuctions
Description

Execute this search among the given list of auctions.

Parametersosid.id.IdListauctionIds list of auctions
ErrorsNULL_ARGUMENT auctionIds is null
Compliancemandatory This method must be implemented.
MethodorderAuctionResults
Description

Specify an ordering to the search results.

Parametersosid.bidding.AuctionSearchOrderauctionSearchOrder auction search order
ErrorsNULL_ARGUMENT auctionSearchOrder is null
UNSUPPORTED auctionSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetAuctionSearchRecord
Description

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

Parametersosid.type.TypeauctionSearchRecordType an auction search record type
Returnosid.bidding.records.AuctionSearchRecord the auction search record
ErrorsNULL_ARGUMENT auctionSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(auctionSearchRecordType) is false
Compliancemandatory This method must be implemented.