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

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

MethodgetAuctionHouses
Description

Gets the auction house list resulting from a search.

Returnosid.bidding.AuctionHouseListthe auction house list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseQueryInspector
Description

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

Returnosid.bidding.AuctionHouseQueryInspectorthe auction house query inspector
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseSearchResultsRecord
Description

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

Parametersosid.type.TypeauctionHouseSearchRecordTypean auction house search record type
Returnosid.bidding.records.AuctionHouseSearchResultsRecordthe auction house search results record
ErrorsNULL_ARGUMENT auctionHouseSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(auctionHouseSearchRecordType) is false
CompliancemandatoryThis method must be implemented.