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

Interface	osid.bidding.rules.AuctionConstrainerSearchSession
Implements	`osid.bidding.rules.AuctionConstrainerQuerySession`
Used By	`osid.bidding.rules.BiddingRulesManager`
Used By	`osid.bidding.rules.BiddingRulesProxyManager`
Description	This session provides methods for searching among `AuctionConstrainer` objects. The search query is constructed using the `AuctionConstraineryQuery` . `getAuctionConstrainersByQuery()` is the basic search method and returns a list of `AuctionConstrainers` . A more advanced search may be performed with `getAuctionConstrainersBySearch()` . It accepts an `AuctionConstrainerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as bidding. `getAuctionConstrainersBySearch()` returns an `AuctionConstrainerSearchResults` that can be used to access the resulting `AuctionConstrainerList` or be used to perform a search within the result set through `AuctionConstrainerSearch` . This session defines views that offer differing behaviors for searching. federated auction house view: searches include auction constrainer 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 constrainer in this auction house `AuctionConstrainers` may have a query record indicated by their respective record types. The query record is accessed via the `AuctionConstrainerQuery` .
Method	getAuctionConstrainerSearch
Description	Gets an auction constrainer search.
Return	`osid.bidding.rules.AuctionConstrainerSearch`		the auction constrainer search
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionConstrainerSearchOrder
Description	Gets an auction constrainer search order. The `AuctionConstrainerSearchOrder` is supplied to an `AuctionConstrainerSearch` to specify the ordering of results.
Return	`osid.bidding.rules.AuctionConstrainerSearchOrder`		the auction constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionConstrainersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.bidding.rules.AuctionConstrainerQuery`	`auctionConstrainerQuery`	the auction constrainer query
Parameters	`osid.bidding.rules.AuctionConstrainerSearch`	`auctionConstrainerSearch`	the auction constrainer search
Return	`osid.bidding.rules.AuctionConstrainerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`auctionConstrainerQuery` or `auctionConstrainerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auctionConstrainerQuery` or `auctionConstrainerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionConstrainerQueryFromInspector
Description	Gets an auction constrainer query from an inspector. The inspector is available from an `AuctionConstrainerSearchResults` .
Parameters	`osid.bidding.rules.AuctionConstrainerQueryInspector`	`auctionConstrainerQueryInspector`	an auction constrainer query inspector
Return	`osid.bidding.rules.AuctionConstrainerQuery`		the auction constrainer query
Errors	NULL_ARGUMENT		`auctionConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`auctionConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.