OSID - osid.bidding.AuctionSearchSession Service Interface Definition

Interface	osid.bidding.AuctionSearchSession
Implements	`osid.bidding.AuctionQuerySession`
Used By	`osid.bidding.BiddingManager`
Used By	`osid.bidding.BiddingProxyManager`
Description	This session provides methods for searching among `Auctions` . The search query is constructed using the `AuctionQuery` . `getAuctionsByQuery()` is the basic search method and returns a list of `Auctions` . A more advanced search may be performed with `getAuctionsBySearch()` .It accepts an `AuctionSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAuctionsBySearch()` returns an `AuctionSearchResults` that can be used to access the resulting `AuctionList` or be used to perform a search within the result set through `AuctionSearch` . This session defines views that offer differing behaviors for searching. federated auction house view: searches include auctions in auction houses of which this auction house is an ancestor in the auction house hierarchy isolated auction house view: searches are restricted to auctions in this auction house Auctions may have a query record indicated by their respective record types. The query record is accessed via the `AuctionQuery` .
Method	getAuctionSearch
Description	Gets an auction search.
Return	`osid.bidding.AuctionSearch`		the auction search
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionSearchOrder
Description	Gets an auction search order. The `AuctionSearchOrder` is supplied to an `AuctionSearch` to specify the ordering of results.
Return	`osid.bidding.AuctionSearchOrder`		the auction search order
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.bidding.AuctionQuery`	`auctionQuery`	the auction query
Parameters	`osid.bidding.AuctionSearch`	`auctionSearch`	the auction search
Return	`osid.bidding.AuctionSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`auctionQuery` or `auctionSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auctionQuery` or `auctionSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionQueryFromInspector
Description	Gets an auction query from an inspector. The inspector is available from an `AuctionSearchResults` .
Parameters	`osid.bidding.AuctionQueryInspector`	`auctionQueryInspector`	an auction query inspector
Return	`osid.bidding.AuctionQuery`		the auction query
Errors	NULL_ARGUMENT		`auctionQueryInspector` is `null`
Errors	UNSUPPORTED		`auctionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.