OSID - osid.metering.StatisticSmartUtilitySession Service Interface Definition

Interface	osid.metering.StatisticSmartUtilitySession
Implements	`osid.OsidSession`
Used By	`osid.metering.MeteringManager`
Used By	`osid.metering.MeteringProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `StatisticQuery` can be retrieved from this session and mapped to this `Utility` to create a virtual collection of `Statistics`. The entries may be sequenced using the `StatisticSearchOrder` from this session. This `Utility` has a default query that matches any statistic and a default search order that specifies no sequencing. The queries may be examined using a `StatisticQueryInspector`. The query may be modified by converting the inspector back to a `StatisticQuery`.
Method	getUtilityId
Description	Gets the `Utility` `Id` associated with this session.
Return	`osid.id.Id`		the `Utility Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getUtility
Description	Gets the `Utility` associated with this session.
Return	`osid.metering.Utility`		the `Utility` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartUtilities
Description	Tests if this user can manage smart utilities. 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 smart operations.
Return	`boolean`		`false` if smart utility methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getStatisticSearchOrder
Description	Gets a statistic search order.
Return	`osid.metering.StatisticSearchOrder`		the statistic search order
Compliance	`mandatory`		This method must be implemented.
Method	applyStatisticQuery
Description	Applies a statistic query to this utility.
Parameters	`osid.metering.StatisticQuery`	`statisticQuery`	the statistic query
Errors	NULL_ARGUMENT		`statisticQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`statisticQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectStatisticQuery
Description	Gets a statistic query inspector for this utility.
Return	`osid.metering.StatisticQueryInspector`		the statistic query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyStatisticSequencing
Description	Applies a statistic search order to this utility.
Parameters	`osid.metering.StatisticSearchOrder`	`statisticSearchOrder`	the statistic search order
Errors	NULL_ARGUMENT		`statisticSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`statisticSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStatisticQueryFromInspector
Description	Gets a statistic query from an inspector.
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.