Interface | osid.bidding.AuctionSearchSession | ||
---|---|---|---|
Implements | osid.bidding.AuctionQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Auctions may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getAuctionSearch | ||
Description |
Gets an auction search. | ||
Return | osid.bidding.AuctionSearch | the auction search | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionSearchOrder | ||
Description |
Gets an auction search order. The | ||
Return | osid.bidding.AuctionSearchOrder | the auction search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.bidding.AuctionQuery | auctionQuery | the auction query |
osid.bidding.AuctionSearch | auctionSearch | the auction search | |
Return | osid.bidding.AuctionSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | auctionQuery or auctionSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | auctionQuery or auctionSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionQueryFromInspector | ||
Description |
Gets an auction query from an inspector. The inspector
is available from an | ||
Parameters | osid.bidding.AuctionQueryInspector | auctionQueryInspector | an auction query inspector |
Return | osid.bidding.AuctionQuery | the auction query | |
Errors | NULL_ARGUMENT | auctionQueryInspector is null | |
UNSUPPORTED | auctionQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |