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

Interface	osid.bidding.rules.BidEnablerSearchSession
Implements	`osid.bidding.rules.BidEnablerQuerySession`
Used By	`osid.bidding.rules.BiddingRulesManager`
Used By	`osid.bidding.rules.BiddingRulesProxyManager`
Description	This session provides methods for searching among `BidEnablers` . The search query is constructed using the `BidEnablerQuery` . `getBidEnablersByQuery()` is the basic search method and returns a list of `BidEnablers` . A more advanced search may be performed with `getBidEnablersBySearch()` .It accepts a `BidEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBidEnablersBySearch()` returns a `BidEnablerSearchResults` that can be used to access the resulting `BidEnablerList` or be used to perform a search within the result set through Bid `EnablerSearch` . This session defines views that offer differing behaviors for searching. federated auction house view: searches include bid 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 bid enablers in this auction house Bid enablers may have a query record indicated by their respective record types. The query record is accessed via the `BidEnablerQuery` .
Method	getBidEnablerSearch
Description	Gets a bid enabler search.
Return	`osid.bidding.rules.BidEnablerSearch`		the bid enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getBidEnablerSearchOrder
Description	Gets a bid enabler search order. The `BidEnablerSearchOrder` is supplied to a `BidEnablerSearch` to specify the ordering of results.
Return	`osid.bidding.rules.BidEnablerSearchOrder`		the bid enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getBidEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.bidding.rules.BidEnablerQuery`	`bidEnablerQuery`	the bid enabler query
Parameters	`osid.bidding.rules.BidEnablerSearch`	`bidEnablerSearch`	the bid enabler search
Return	`osid.bidding.rules.BidEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`bidEnablerQuery` or `bidEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`bidEnablerQuery` or `bidEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBidEnablerQueryFromInspector
Description	Gets a bid enabler query from an inspector. The inspector is available from a `BidEnablerSearchResults` .
Parameters	`osid.bidding.rules.BidEnablerQueryInspector`	`bidEnablerQueryInspector`	a bid enabler query inspector
Return	`osid.bidding.rules.BidEnablerQuery`		the bid enabler query
Errors	NULL_ARGUMENT		`bidEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`bidEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.