OSID Logo
OSID Specifications
bidding package
Version 3.1.0
Interfaceosid.bidding.AuctionHouseSearchSession
Implementsosid.bidding.AuctionHouseQuerySession
Used Byosid.bidding.BiddingManager
osid.bidding.BiddingProxyManager
Description

This session provides methods for searching among AuctionHouses. The search query is constructed using the AuctionHouseQuery.

getAuctionHousesByQuery() is the basic search method and returns a list of Auction Houses. A more advanced search may be performed with getAuctionHousesBySearch().It accepts an AuctionHouseSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuctionHousesBySearch() returns an AuctionHouseSearchResults that can be used to access the resulting AuctionHouseList or be used to perform a search within the result set through AuctionHouseSearch.

AuctionHouses may have a query record indicated by their respective record types. The query record is accessed via the AuctionHouseQuery.

MethodgetAuctionHouseSearch
Description

Gets an auction house search.

Returnosid.bidding.AuctionHouseSearch the auction house search
Compliancemandatory This method must be implemented.
MethodgetAuctionHouseSearchOrder
Description

Gets an auction house search order. The AuctionHouseSearchOrder is supplied to an AuctionHouseSearch to specify the ordering of results.

Returnosid.bidding.AuctionHouseSearchOrder the auction house search order
Compliancemandatory This method must be implemented.
MethodgetAuctionHousesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.bidding.AuctionHouseQueryauctionHouseQuery the auction house query
osid.bidding.AuctionHouseSearchauctionHouseSearch the auction house search
Returnosid.bidding.AuctionHouseSearchResults the returned search results
ErrorsNULL_ARGUMENT auctionHouseQuery or auctionHouseSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED auctionHouseQuery or auctionHouseSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetAuctionHouseQueryFromInspector
Description

Gets an auction house query from an inspector. The inspector is available from an AuctionHouseSearchResults.

Parametersosid.bidding.AuctionHouseQueryInspectorauctionHouseQueryInspector an auction house query inspector
Returnosid.bidding.AuctionHouseQuery the auction house query
ErrorsNULL_ARGUMENT auctionHouseQueryInspector is null
UNSUPPORTED auctionHouseQueryInspector is not of this service
Compliancemandatory This method must be implemented.