OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Interfaceosid.bidding.rules.BidEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.bidding.rules.BidEnablerSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetBidEnablers
Description

Gets the bid enabler list resulting from a search.

Returnosid.bidding.rules.BidEnablerListthe bid enabler list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetBidEnablerQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.bidding.rules.BidEnablerQueryInspectorthe bid enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetBidEnablerSearchResultsRecord
Description

Gets the bid enabler search results 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.BidEnablerSearchResultsRecordthe bid enabler search results record
ErrorsNULL_ARGUMENTbidEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(bidEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.