Interface | osid.bidding.AuctionSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing auction searches. | ||
Method | searchAmongAuctions | ||
Description |
Execute this search among the given list of auctions. | ||
Parameters | osid.id.IdList | auctionIds | list of auctions |
Errors | NULL_ARGUMENT | auctionIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderAuctionResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.bidding.AuctionSearchOrder | auctionSearchOrder | auction search order |
Errors | NULL_ARGUMENT | auctionSearchOrder is null | |
UNSUPPORTED | auctionSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionSearchRecord | ||
Description |
Gets the auction search record corresponding to the
given auction search record | ||
Parameters | osid.type.Type | auctionSearchRecordType | an auction search record type |
Return | osid.bidding.records.AuctionSearchRecord | the auction search 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. |