Interface | osid.metering.StatisticSearchSession | ||
---|---|---|---|
Implements | osid.metering.MeterQuerySession | ||
Description |
This session provides methods for searching among
statistics The search query is constructed using the This session defines views that offer differing behaviors for searching.
| ||
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 | ||
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 |
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 | ||
Parameters | osid.metering.StatisticQueryInspector | statisticQueryInspector | a statistic query inspector |
Return | osid.metering.StatisticQuery | the statistic query | |
Errors | NULL_ARGUMENT | statisticQueryInspector is null | |
UNSUPPORTED | statisticQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |