Interface | osid.bidding.BidSearchSession | ||
---|---|---|---|
Implements | osid.bidding.BidQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Bids may have a query record indicated by their respective
record types. The query record is accessed via the | ||
Method | getBidSearch | ||
Description |
Gets a bid search. | ||
Return | osid.bidding.BidSearch | the bid search | |
Compliance | mandatory | This method must be implemented. | |
Method | getBidSearchOrder | ||
Description |
Gets a bid search order. The | ||
Return | osid.bidding.BidSearchOrder | the bid search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getBidsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.bidding.BidQuery | bidQuery | the bid query |
osid.bidding.BidSearch | bidSearch | the bid search | |
Return | osid.bidding.BidSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | bidQuery or bidSearch is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | bidQuery or bidSearch is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBidQueryFromInspector | ||
Description |
Gets a bid query from an inspector. The inspector is
available from a | ||
Parameters | osid.bidding.BidQueryInspector | bidQueryInspector | a bid query inspector |
Return | osid.bidding.BidQuery | the bid query | |
Errors | NULL_ARGUMENT | bidQueryInspector is null | |
UNSUPPORTED | bidQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |