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

Interface	osid.ordering.rules.PriceEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.ordering.rules.PriceEnablerSearchSession`
Used By	`osid.ordering.rules.OrderingRulesManager`
Used By	`osid.ordering.rules.OrderingRulesProxyManager`
Description	This session provides methods for searching among `PriceEnabler` objects. The search query is constructed using the `PriceEnablerQuery`. 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 Price enablers may have a query record indicated by their respective record types. The query record is accessed via the `PriceEnablerQuery`.
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	canSearchPriceEnablers
Description	Tests if this user can perform `PriceEnabler` lookups. 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 not offer lookup 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 price enablers in stores which are children of this broker 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 lookups to this store only.
Compliance	`mandatory`		This method is must be implemented.
Method	getPriceEnablerQuery
Description	Gets a price enabler query.
Return	`osid.ordering.rules.PriceEnablerQuery`		the price enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablersByQuery
Description	Gets a list of `PriceEnablers` matching the given price enabler query.
Parameters	`osid.ordering.rules.PriceEnablerQuery`	`priceEnablerQuery`	the price enabler query
Return	`osid.ordering.rules.PriceEnablerList`		the returned `PriceEnablerList`
Errors	NULL_ARGUMENT		`priceEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`priceEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.