| Interface | osid.bidding.rules.BidEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.bidding.rules.BidEnablerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getBidEnablers | ||
| Description |
Gets the bid enabler list resulting from a search. | ||
| Return | osid.bidding.rules.BidEnablerList | the bid enabler list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBidEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.bidding.rules.BidEnablerQueryInspector | the bid enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBidEnablerSearchResultsRecord | ||
| Description |
Gets the bid enabler search results 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.BidEnablerSearchResultsRecord | the bid enabler search results 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. | |