Interface StatisticSearchSession

All Superinterfaces:

AutoCloseable, Closeable, MeterQuerySession, OsidSession, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface MeterQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchMeters()	Tests if this user can perform Meter searches.
MeterQuery	getMeterQuery()	Gets a meter query.
MeterList	getMetersByQuery(MeterQuery meterQuery)	Gets a list of meters matching the given meter query.
Utility	getUtility()	Gets the Utility associated with this session.
Id	getUtilityId()	Gets the Utility Id associated with this session.
void	useFederatedUtilityView()	Federates the view for methods in this session.
void	useIsolatedUtilityView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.