OSID - osid.ordering.ProductQuerySession Service Interface Definition

Interface	osid.ordering.ProductQuerySession
Implements	`osid.OsidSession`
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. 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	getStoreId
Description	Gets the `Store` `Id` associated with this session.
Return	`osid.id.Id`		the `Store Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getStore
Description	Gets the `Store` associated with this session.
Return	`osid.ordering.Store`		the store
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchProducts
Description	Tests if this user can perform `Product` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedStoreView
Description	Federates the view for methods in this session. A federated view will include products in stores which are children of this store in the store hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedStoreView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this store only.
Compliance	`mandatory`		This method is must be implemented.
Method	getProductQuery
Description	Gets a product query.
Return	`osid.ordering.ProductQuery`		the product query
Compliance	`mandatory`		This method must be implemented.
Method	getProductsByQuery
Description	Gets a list of `Products` matching the given product query.
Parameters	`osid.ordering.ProductQuery`	`productQuery`	the product query
Return	`osid.ordering.ProductList`		the returned `ProductList`
Errors	NULL_ARGUMENT		`productQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`productQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.