OSID - osid.ordering.rules.PriceEnablerSearchSession Service Interface Definition

Interface	osid.ordering.rules.PriceEnablerSearchSession
Implements	`osid.ordering.rules.PriceEnablerQuerySession`
Description	This session provides methods for searching among `PriceEnabler` objects. The search query is constructed using the `PriceEnableryQuery.` `getPriceEnablersByQuery()` is the basic search method and returns a list of `PriceEnablers.` A more advanced search may be performed with `getPriceEnablersBySearch().` It accepts a `PriceEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPriceEnablersBySearch()` returns a `PriceEnablerSearchResults` that can be used to access the resulting `PriceEnablerList` or be used to perform a search within the result set through `PriceEnablerSearch.` This session defines views that offer differing behaviors for searching. federated store view: searches include price enablers in stores of which this store is an ancestor in the store hierarchy isolated store view: searches are restricted to price enablers in this store `PriceEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `PriceEnablerQuery.`
Method	getPriceEnablerSearch
Description	Gets a price enabler search.
Return	`osid.ordering.rules.PriceEnablerSearch`		the price enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablerSearchOrder
Description	Gets a price enabler search order. The `PriceEnablerSearchOrder` is supplied to a `PriceEnablerSearch` to specify the ordering of results.
Return	`osid.ordering.rules.PriceEnablerSearchOrder`		the price enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.ordering.rules.PriceEnablerQuery`	`priceEnablerQuery`	the price enabler query
Parameters	`osid.ordering.rules.PriceEnablerSearch`	`priceEnablerSearch`	the price enabler search
Return	`osid.ordering.rules.PriceEnablerSearchResults`		the price enabler search results
Errors	NULL_ARGUMENT		`priceEnablerQuery` or `priceEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`priceEnablerQuery` or `priceEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablerQueryFromInspector
Description	Gets a price enabler query from an inspector. The inspector is available from a `PriceEnablerSearchResults.`
Parameters	`osid.ordering.rules.PriceEnablerQueryInspector`	`priceEnablerQueryInspector`	a price enabler query inspector
Return	`osid.ordering.rules.PriceEnablerQuery`		the price enabler query
Errors	NULL_ARGUMENT		`priceEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`priceEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.