OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
bidding package
Version 3.0.0
Release Candidate Preview
| Interface | osid.bidding.BidSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getBids | ||
| Description |
Gets the bid list resulting from a search. | ||
| Return | osid.bidding.BidList | the bid list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBidQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.bidding.BidQueryInspector | the bid query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBidSearchResultsRecord | ||
| Description |
Gets the bid search results record corresponding to the
given bid search record | ||
| Parameters | osid.type.Type | bidSearchRecordType | a bid search record type |
| Return | osid.bidding.records.BidSearchResultsRecord | the bid search results 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. | |