| Interface | osid.bidding.AuctionHouseSearchSession | ||
|---|---|---|---|
| Implements | osid.bidding.AuctionHouseQuerySession | ||
| Used By | osid.bidding.BiddingManager | ||
osid.bidding.BiddingProxyManager | |||
| Description |
This session provides methods for searching among
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
| ||
| Method | getAuctionHouseSearch | ||
| Description |
Gets an auction house search. | ||
| Return | osid.bidding.AuctionHouseSearch | the auction house search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuctionHouseSearchOrder | ||
| Description |
Gets an auction house search order. The
| ||
| Return | osid.bidding.AuctionHouseSearchOrder | the auction house search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuctionHousesBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.bidding.AuctionHouseQuery | auctionHouseQuery | the auction house query |
osid.bidding.AuctionHouseSearch | auctionHouseSearch | the auction house search | |
| Return | osid.bidding.AuctionHouseSearchResults | the returned search results | |
| Errors | NULL_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 | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuctionHouseQueryFromInspector | ||
| Description |
Gets an auction house query from an inspector. The
inspector is available from an
| ||
| Parameters | osid.bidding.AuctionHouseQueryInspector | auctionHouseQueryInspector | an auction house query inspector |
| Return | osid.bidding.AuctionHouseQuery | the auction house query | |
| Errors | NULL_ARGUMENT | auctionHouseQueryInspector is null | |
| UNSUPPORTED | auctionHouseQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |