OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.rules.AuctionConstrainerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetAuctionConstrainers
Description

Gets the AuctionConstrainerList resulting from a search.

Returnosid.bidding.rules.AuctionConstrainerListthe auction constrainer list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerQueryInspector
Description

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

Returnosid.bidding.rules.AuctionConstrainerQueryInspectorthe auction constrainer query inspector
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerSearchResultsRecord
Description

Gets the auction constrainer search results record corresponding to the given auction constrainer search record Type. This method must be used to retrieve an object implementing the requested record.

Parametersosid.type.TypeauctionConstrainerSearchRecordTypean auction constrainer search record type
Returnosid.bidding.rules.records.AuctionConstrainerSearchResultsRecordthe auction constrainer search results record
ErrorsNULL_ARGUMENT auctionConstrainerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(auctionConstrainerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.