OSID - osid.bidding.rules.AuctionProcessorSearchSession Service Interface Definition

Interface	osid.bidding.rules.AuctionProcessorSearchSession
Implements	`osid.bidding.rules.AuctionProcessorQuerySession`
Used By	`osid.bidding.rules.BiddingRulesManager`
Used By	`osid.bidding.rules.BiddingRulesProxyManager`
Description	This session provides methods for searching among `AuctionProcessor` objects. The search query is constructed using the `AuctionProcessoryQuery` . `getAuctionProcessorsByQuery()` is the basic search method and returns a list of `AuctionProcessors` . A more advanced search may be performed with `getAuctionProcessorsBySearch()` . It accepts an `AuctionProcessorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as bidding. `getAuctionProcessorsBySearch()` returns an `AuctionProcessorSearchResults` that can be used to access the resulting `AuctionProcessorList` or be used to perform a search within the result set through `AuctionProcessorSearch` . This session defines views that offer differing behaviors for searching. federated auction house view: searches include auction processor in auction houses of which this auction house is an ancestor in the auction house hierarchy isolated auction house view: searches are restricted to auction processor in this auction house `AuctionProcessors` may have a query record indicated by their respective record types. The query record is accessed via the `AuctionProcessorQuery` .
Method	getAuctionProcessorSearch
Description	Gets an auction processor search.
Return	`osid.bidding.rules.AuctionProcessorSearch`		the auction processor search
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorSearchOrder
Description	Gets an auction processor search order. The `AuctionProcessorSearchOrder` is supplied to an `AuctionProcessorSearch` to specify the ordering of results.
Return	`osid.bidding.rules.AuctionProcessorSearchOrder`		the auction processor search order
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.bidding.rules.AuctionProcessorQuery`	`auctionProcessorQuery`	the auction processor query
Parameters	`osid.bidding.rules.AuctionProcessorSearch`	`auctionProcessorSearch`	the auction processor search
Return	`osid.bidding.rules.AuctionProcessorSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`auctionProcessorQuery` or `auctionProcessorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auctionProcessorQuery` or `auctionProcessorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorQueryFromInspector
Description	Gets an auction processor query from an inspector. The inspector is available from an `AuctionProcessorSearchResults` .
Parameters	`osid.bidding.rules.AuctionProcessorQueryInspector`	`auctionProcessorQueryInspector`	an auction processor query inspector
Return	`osid.bidding.rules.AuctionProcessorQuery`		the auction processor query
Errors	NULL_ARGUMENT		`auctionProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`auctionProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.