OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
bidding package
Version 3.0.0
Release Candidate Preview
| Interface | osid.bidding.BidSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing bid searches. | ||
| Method | searchAmongBids | ||
| Description |
Execute this search among the given list of bids. | ||
| Parameters | osid.id.IdList | bidIds | list of bids |
| Errors | NULL_ARGUMENT | bidIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBidResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.bidding.BidSearchOrder | bidSearchOrder | bid search order |
| Errors | NULL_ARGUMENT | bidSearchOrder is null | |
| UNSUPPORTED | bidSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getBidSearchRecord | ||
| Description |
Gets the bid search record corresponding to the given
bid search record | ||
| Parameters | osid.type.Type | bidSearchRecordType | a bid search record type |
| Return | osid.bidding.records.BidSearchRecord | the bid search record | |
| Errors | NULL_ARGUMENT | bidSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(bidSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |