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

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

MethodgetAuctions
Description

Gets the auction list resulting from a search.

Returnosid.bidding.AuctionListthe auction list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetAuctionQueryInspector
Description

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

Returnosid.bidding.AuctionQueryInspectorthe auction query inspector
CompliancemandatoryThis method must be implemented.
MethodgetAuctionSearchResultsRecord
Description

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

Parametersosid.type.TypeauctionSearchRecordTypean auction search record type
Returnosid.bidding.records.AuctionSearchResultsRecordthe auction search results record
ErrorsNULL_ARGUMENT auctionSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(auctionSearchRecordType) is false
CompliancemandatoryThis method must be implemented.