| Interface | osid.bidding.rules.BidEnablerSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.bidding.rules.BidEnablerSearchSession | ||
| Description |
The search interface for governing bid enabler searches. | ||
| Method | searchAmongBidEnablers | ||
| Description |
Execute this search among the given list of bid enablers. | ||
| Parameters | osid.id.IdList | bidEnablerIds | list of bid enablers |
| Errors | NULL_ARGUMENT | bidEnablerIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBidEnablerResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.bidding.rules.BidEnablerSearchOrder | bidEnablerSearchOrder | bid enabler search order |
| Errors | NULL_ARGUMENT | bidEnablerSearchOrder is null | |
| UNSUPPORTED | bidEnablerSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getBidEnablerSearchRecord | ||
| Description |
Gets the bid enabler search record corresponding to the
given bid enabler search record | ||
| Parameters | osid.type.Type | bidEnablerSearchRecordType | a bid enabler search record type |
| Return | osid.bidding.rules.records.BidEnablerSearchRecord | the bid enabler search record | |
| Errors | NULL_ARGUMENT | bidEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(bidEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |