org.osid.metering

Interface StatisticSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, MeterQuerySession, OsidSession

public interface StatisticSearchSession
extends MeterQuerySession

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

Method Summary

Methods

Modifier and Type	Method and Description
StatisticQuery	getStatisticQueryFromInspector(StatisticQueryInspector statisticQueryInspector) Gets a statistic query from an inspector.
StatisticSearchResults	getStatisticsBySearch(StatisticQuery statisticQuery, StatisticSearch statisticSearch) Gets the search results matching the given search query using the given search.
StatisticSearch	getStatisticSearch() Gets a statistic search.
StatisticSearchOrder	getStatisticSearchOrder() Gets a statistic search order.

Methods inherited from interface org.osid.metering.MeterQuerySession

canSearchMeters, getMeterQuery, getMetersByQuery, getUtility, getUtilityId, useFederatedUtilityView, useIsolatedUtilityView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getStatisticSearch

StatisticSearch getStatisticSearch()

Gets a statistic search.

Returns:

the statistic search

Compliance:

mandatory - This method must be implemented.

getStatisticSearchOrder

StatisticSearchOrder getStatisticSearchOrder()

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

Returns:

the statistic search order

Compliance:

mandatory - This method must be implemented.

getStatisticsBySearch

StatisticSearchResults getStatisticsBySearch(StatisticQuery statisticQuery,
                                           StatisticSearch statisticSearch)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

statisticQuery - the statistics query

statisticSearch - the statistics search

Returns:

the returned search results

Throws:

NullArgumentException - statisticQuery or statisticSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - statisticQuery or statisticSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getStatisticQueryFromInspector

StatisticQuery getStatisticQueryFromInspector(StatisticQueryInspector statisticQueryInspector)

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

Parameters:

statisticQueryInspector - a statistic query inspector

Returns:

the statistic query

Throws:

NullArgumentException - statisticQueryInspector is null

UnsupportedException - statisticQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.