OSID - osid.metering.StatisticSearchSession Service Interface Definition

Interface	osid.metering.StatisticSearchSession
Implements	`osid.metering.MeterQuerySession`
Used By	`osid.metering.MeteringManager`
Used By	`osid.metering.MeteringProxyManager`
Description	This session provides methods for searching among statistics The search query is constructed using the `StatisticQuery`. `getStatisticsByQuery()` is the basic search method and returns a list of statistics. A more advanced search may be performed with `getStatisticsBySearch()`. It accepts a `StatisticSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getStatisticsBySearch()` returns a `StatisticSearchResults` that can be used to access the resulting `StatisticList` or be used to perform a search within the result set through `StatisticSearch`. This session defines views that offer differing behaviors for searching. federated utility view: searches include statistic in utilities of which this utility is an ancestor in the utility hierarchy isolated utility view: searches are restricted to statistics in this utility only
Method	getStatisticSearch
Description	Gets a statistic search.
Return	`osid.metering.StatisticSearch`		the statistic search
Compliance	`mandatory`		This method must be implemented.
Method	getStatisticSearchOrder
Description	Gets a statistic search order. The `StatisticSearchOrder` is supplied to a `StatisticSearch` to specify the ordering of results.
Return	`osid.metering.StatisticSearchOrder`		the statistic search order
Compliance	`mandatory`		This method must be implemented.
Method	getStatisticsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.metering.StatisticQuery`	`statisticQuery`	the statistics query
Parameters	`osid.metering.StatisticSearch`	`statisticSearch`	the statistics search
Return	`osid.metering.StatisticSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`statisticQuery` or `statisticSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`statisticQuery` or `statisticSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStatisticQueryFromInspector
Description	Gets a statistic query from an inspector. The inspector is available from a `StatisticSearchResults`.
Parameters	`osid.metering.StatisticQueryInspector`	`statisticQueryInspector`	a statistic query inspector
Return	`osid.metering.StatisticQuery`		the statistic query
Errors	NULL_ARGUMENT		`statisticQueryInspector` is `null`
Errors	UNSUPPORTED		`statisticQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.