Interface | osid.metering.StatisticQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching statistics. The
search query is constructed using the This session defines views that offer differing behaviors for searching.
| ||
Method | getUtilityId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Utility Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getUtility | ||
Description |
Gets the | ||
Return | osid.metering.Utility | the Utility associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchStatistics | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedUtilityView | ||
Description |
Federates the view for methods in this session. A federated view will include statistics in utilities which are children of this utility in the utility hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedUtilityView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this utility only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getStatisticQuery | ||
Description |
Gets a statistic query. | ||
Return | osid.metering.StatisticQuery | the statistic query | |
Compliance | mandatory | This method must be implemented. | |
Method | getStatisticsByQuery | ||
Description |
Gets a list of statistics matching the given statistics query. | ||
Parameters | osid.metering.StatisticQuery | statisticQuery | the statistics query |
Return | osid.metering.StatisticList | the returned StatisticList | |
Errors | NULL_ARGUMENT | statisticQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | statisticQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |