OSID Logo
OSID Specifications
bidding rules package
Version 3.1.0
Interfaceosid.bidding.rules.BidEnablerSearch
Implementsosid.OsidSearch
Used Byosid.bidding.rules.BidEnablerSearchSession
Description

The search interface for governing bid enabler searches.

MethodsearchAmongBidEnablers
Description

Execute this search among the given list of bid enablers.

Parametersosid.id.IdListbidEnablerIds list of bid enablers
ErrorsNULL_ARGUMENT bidEnablerIds is null
Compliancemandatory This method must be implemented.
MethodorderBidEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.bidding.rules.BidEnablerSearchOrderbidEnablerSearchOrder bid enabler search order
ErrorsNULL_ARGUMENT bidEnablerSearchOrder is null
UNSUPPORTED bidEnablerSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetBidEnablerSearchRecord
Description

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

Parametersosid.type.TypebidEnablerSearchRecordType a bid enabler search record type
Returnosid.bidding.rules.records.BidEnablerSearchRecord the bid enabler search record
ErrorsNULL_ARGUMENT bidEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(bidEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.