OSID Logo
OSID Specifications
bidding package
Version 3.1.0
Interfaceosid.bidding.BidSearch
Implementsosid.OsidSearch
Used Byosid.bidding.BidSearchSession
Description

The search interface for governing bid searches.

MethodsearchAmongBids
Description

Execute this search among the given list of bids.

Parametersosid.id.IdListbidIds list of bids
ErrorsNULL_ARGUMENT bidIds is null
Compliancemandatory This method must be implemented.
MethodorderBidResults
Description

Specify an ordering to the search results.

Parametersosid.bidding.BidSearchOrderbidSearchOrder bid search order
ErrorsNULL_ARGUMENT bidSearchOrder is null
UNSUPPORTED bidSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetBidSearchRecord
Description

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

Parametersosid.type.TypebidSearchRecordType a bid search record type
Returnosid.bidding.records.BidSearchRecord the bid search record
ErrorsNULL_ARGUMENT bidSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(bidSearchRecordType) is false
Compliancemandatory This method must be implemented.