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

The search interface for governing auction searches.

MethodsearchAmongAuctions
Description

Execute this search among the given list of auctions.

Parametersosid.id.IdListauctionIdslist of auctions
ErrorsNULL_ARGUMENT auctionIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAuctionResults
Description

Specify an ordering to the search results.

Parametersosid.bidding.AuctionSearchOrderauctionSearchOrderauction search order
ErrorsNULL_ARGUMENT auctionSearchOrder is null
UNSUPPORTED auctionSearchOrder is not of this service
CompliancemandatoryThis 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.TypeauctionSearchRecordTypean auction search record type
Returnosid.bidding.records.AuctionSearchRecordthe auction search record
ErrorsNULL_ARGUMENT auctionSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(auctionSearchRecordType) is false
CompliancemandatoryThis method must be implemented.