OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.StatisticSearchSession
Implementsosid.metering.MeterQuerySession
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
MethodgetStatisticSearch
Description

Gets a statistic search.

Returnosid.metering.StatisticSearchthe statistic search
CompliancemandatoryThis method must be implemented.
MethodgetStatisticSearchOrder
Description

Gets a statistic search order. The StatisticSearchOrder is supplied to a StatisticSearch to specify the ordering of results.

Returnosid.metering.StatisticSearchOrderthe statistic search order
CompliancemandatoryThis method must be implemented.
MethodgetStatisticsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.metering.StatisticQuerystatisticQuerythe statistics query
osid.metering.StatisticSearchstatisticSearchthe statistics search
Returnosid.metering.StatisticSearchResultsthe returned search results
ErrorsNULL_ARGUMENT statisticQuery or statisticSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED statisticQuery or statisticSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStatisticQueryFromInspector
Description

Gets a statistic query from an inspector. The inspector is available from a StatisticSearchResults.

Parametersosid.metering.StatisticQueryInspectorstatisticQueryInspectora statistic query inspector
Returnosid.metering.StatisticQuerythe statistic query
ErrorsNULL_ARGUMENT statisticQueryInspector is null
UNSUPPORTED statisticQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.