OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.StatisticQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching statistics. The search query is constructed using the StatisticQuery.

This session defines views that offer differing behaviors for searching.

  • federated utility view: searches include statistics 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
MethodgetUtilityId
Description

Gets the Utility Id associated with this session.

Returnosid.id.Idthe Utility Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetUtility
Description

Gets the Utility associated with this session.

Returnosid.metering.Utilitythe Utility associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchStatistics
Description

Tests if this user can perform Statistic searches. 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 search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedUtilityView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedUtilityView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this utility only.

CompliancemandatoryThis method is must be implemented.
MethodgetStatisticQuery
Description

Gets a statistic query.

Returnosid.metering.StatisticQuerythe statistic query
CompliancemandatoryThis method must be implemented.
MethodgetStatisticsByQuery
Description

Gets a list of statistics matching the given statistics query.

Parametersosid.metering.StatisticQuerystatisticQuerythe statistics query
Returnosid.metering.StatisticListthe returned StatisticList
ErrorsNULL_ARGUMENT statisticQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED statisticQuery is not of this service
CompliancemandatoryThis method must be implemented.