OSID - osid.ordering.ProductSearchSession Service Interface Definition

Interface	osid.ordering.ProductSearchSession
Implements	`osid.ordering.ProductQuerySession`
Used By	`osid.ordering.OrderingManager`
Used By	`osid.ordering.OrderingProxyManager`
Description	This session provides methods for searching `Product` objects. The search query is constructed using the `ProductQuery`. The product record `Type` also specifies the record for the product query. `getProductsByQuery()` is the basic search method and returns a list of `Product` elements. A more advanced search may be performed with `getProductsBySearch()`.It accepts a `ProductSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProductsBySearch()` returns a `ProductSearchResults` that can be used to access the resulting `ProductList` or be used to perform a search within the result set through `ProductSearch`. Products may have a query record indicated by their respective record types. The query record is accessed via the `ProductQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getProductSearch
Description	Gets a product search.
Return	`osid.ordering.ProductSearch`		the product search
Compliance	`mandatory`		This method must be implemented.
Method	getProductSearchOrder
Description	Gets a product search order. The `ProductSearchOrder` is supplied to a `ProductSearch` to specify the ordering of results.
Return	`osid.ordering.ProductSearchOrder`		the product search order
Compliance	`mandatory`		This method must be implemented.
Method	getProductsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.ordering.ProductQuery`	`productQuery`	the product query
Parameters	`osid.ordering.ProductSearch`	`productSearch`	the product search
Return	`osid.ordering.ProductSearchResults`		the product search results
Errors	NULL_ARGUMENT		`productQuery` or `productSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`productQuery` or `productSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProductQueryFromInspector
Description	Gets a product query from an inspector. The inspector is available from a `ProductSearchResults`.
Parameters	`osid.ordering.ProductQueryInspector`	`productQueryInspector`	a query inspector
Return	`osid.ordering.ProductQuery`		the product query
Errors	NULL_ARGUMENT		`productQueryInspector` is `null`
Errors	UNSUPPORTED		`productQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.