OSID Logo
OSID Specifications
bidding rules package
Version 3.0.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.IdListbidEnablerIdslist of bid enablers
ErrorsNULL_ARGUMENTbidEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderBidEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.bidding.rules.BidEnablerSearchOrderbidEnablerSearchOrderbid enabler search order
ErrorsNULL_ARGUMENTbidEnablerSearchOrder is null
UNSUPPORTEDbidEnablerSearchOrder is not of this service
CompliancemandatoryThis 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.TypebidEnablerSearchRecordTypea bid enabler search record type
Returnosid.bidding.rules.records.BidEnablerSearchRecordthe bid enabler search record
ErrorsNULL_ARGUMENTbidEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(bidEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.