OSID - osid.bidding.BidSearchSession Service Interface Definition

Interface	osid.bidding.BidSearchSession
Implements	`osid.bidding.BidQuerySession`
Description	This session provides methods for searching among `Bid` objects. The search query is constructed using the `BidQuery.` `getBidsByQuery()` is the basic search method and returns a list of `Bids.` A more advanced search may be performed with `getBidsBySearch().` It accepts a `BidSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBidsBySearch()` returns a `BidSearchResults` that can be used to access the resulting `BidList` or be used to perform a search within the result set through `BidSearch.` This session defines views that offer differing behaviors for searching. federated auction house view: searches include bids in auction houses of which this auction house is an ancestor in the auction house hierarchy isolated auction house view: searches are restricted to bids in this auction house Bids may have a query record indicated by their respective record types. The query record is accessed via the `BidQuery.`
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 `BidSearchOrder` is supplied to a `BidSearch` to specify the ordering of results.
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
Parameters	`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 `BidSearchResults.`
Parameters	`osid.bidding.BidQueryInspector`	`bidQueryInspector`	a bid query inspector
Return	`osid.bidding.BidQuery`		the bid query
Errors	NULL_ARGUMENT		`bidQueryInspector` is `null`
Errors	UNSUPPORTED		`bidQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.