Interface | osid.bidding.AuctionSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getAuctions | ||
Description |
Gets the auction list resulting from a search. | ||
Return | osid.bidding.AuctionList | the auction list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.bidding.AuctionQueryInspector | the auction query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionSearchResultsRecord | ||
Description |
Gets the auction search results record corresponding to
the given auction search record | ||
Parameters | osid.type.Type | auctionSearchRecordType | an auction search record type |
Return | osid.bidding.records.AuctionSearchResultsRecord | the auction search results record | |
Errors | NULL_ARGUMENT | auctionSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(auctionSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |