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

Interface	osid.bidding.rules.AuctionProcessorEnablerSearchSession
Implements	`osid.bidding.rules.AuctionProcessorEnablerQuerySession`
Used By	`osid.bidding.rules.BiddingRulesManager`
Used By	`osid.bidding.rules.BiddingRulesProxyManager`
Description	This session provides methods for searching among `AuctionProcessorEnabler` objects. The search query is constructed using the `AuctionProcessorEnableryQuery` . `getAuctionProcessorEnablersByQuery()` is the basic search method and returns a list of `AuctionProcessorEnablers` . A more advanced search may be performed with `getAuctionProcessorEnablersBySearch()` .It accepts an `AuctionProcessorEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as bidding. `getAuctionProcessorEnablersBySearch()` returns an `AuctionProcessorEnablerSearchResults` that can be used to access the resulting `AuctionProcessorEnablerList` or be used to perform a search within the result set through `AuctionProcessorEnablerSearch` . This session defines views that offer differing behaviors for searching. federated auction house view: searches include auction processor enablers 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 enablers in this auction house `AuctionProcessorEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `AuctionProcessorEnablerQuery` .
Method	getAuctionProcessorEnablerSearch
Description	Gets an auction processor enabler search.
Return	`osid.bidding.rules.AuctionProcessorEnablerSearch`		the auction processor enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorEnablerSearchOrder
Description	Gets an auction processor enabler search order. The `AuctionProcessorEnablerSearchOrder` is supplied to an `AuctionProcessorEnablerSearch` to specify the ordering of results.
Return	`osid.bidding.rules.AuctionProcessorEnablerSearchOrder`		the auction processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.bidding.rules.AuctionProcessorEnablerQuery`	`auctionProcessorEnablerQuery`	the auction processor enabler query
Parameters	`osid.bidding.rules.AuctionProcessorEnablerSearch`	`auctionProcessorEnablerSearch`	the auction processor enabler search
Return	`osid.bidding.rules.AuctionProcessorEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`auctionProcessorEnablerQuery` or `auctionProcessorEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auctionProcessorEnablerQuery` or `auctionProcessorEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorEnablerQueryFromInspector
Description	Gets an auction processor enabler query from an inspector. The inspector is available from an `AuctionProcessorEnablerSearchResults` .
Parameters	`osid.bidding.rules.AuctionProcessorEnablerQueryInspector`	`auctionProcessorEnablerQueryInspector`	an auction processor enabler query inspector
Return	`osid.bidding.rules.AuctionProcessorEnablerQuery`		the auction processor enabler query
Errors	NULL_ARGUMENT		`auctionProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`auctionProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.