org.osid.metering

Interface StatisticSmartUtilitySession

All Superinterfaces:

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

public interface StatisticSmartUtilitySession
extends OsidSession

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 Summary

Methods

Modifier and Type	Method and Description
void	applyStatisticQuery(StatisticQuery statisticQuery) Applies a statistic query to this utility.
void	applyStatisticSequencing(StatisticSearchOrder statisticSearchOrder) Applies a statistic search order to this utility.
boolean	canManageSmartUtilities() Tests if this user can manage smart utilities.
StatisticQuery	getStatisticQuery() Gets a statistic query.
StatisticQuery	getStatisticQueryFromInspector(StatisticQueryInspector statisticQueryInspector) Gets a statistic query from an inspector.
StatisticSearchOrder	getStatisticSearchOrder() Gets a statistic search order.
Utility	getUtility() Gets the Utility associated with this session.
Id	getUtilityId() Gets the Utility Id associated with this session.
StatisticQueryInspector	inspectStatisticQuery() Gets a statistic query inspector for this utility.

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

getUtilityId

Id getUtilityId()

Gets the Utility Id associated with this session.

Returns:

the Utility Id associated with this session

Compliance:

mandatory - This method must be implemented.

getUtility

Utility getUtility()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Utility associated with this session.

Returns:

the Utility associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartUtilities

boolean canManageSmartUtilities()

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.

Returns:

false if smart utility methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getStatisticQuery

StatisticQuery getStatisticQuery()

Gets a statistic query.

Returns:

the statistic query

Compliance:

mandatory - This method must be implemented.

getStatisticSearchOrder

StatisticSearchOrder getStatisticSearchOrder()

Gets a statistic search order.

Returns:

the statistic search order

Compliance:

mandatory - This method must be implemented.

applyStatisticQuery

void applyStatisticQuery(StatisticQuery statisticQuery)
                         throws OperationFailedException,
                                PermissionDeniedException

Applies a statistic query to this utility.

Parameters:

statisticQuery - the statistic query

Throws:

NullArgumentException - statisticQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - statisticQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectStatisticQuery

StatisticQueryInspector inspectStatisticQuery()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets a statistic query inspector for this utility.

Returns:

the statistic query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyStatisticSequencing

void applyStatisticSequencing(StatisticSearchOrder statisticSearchOrder)
                              throws OperationFailedException,
                                     PermissionDeniedException

Applies a statistic search order to this utility.

Parameters:

statisticSearchOrder - the statistic search order

Throws:

NullArgumentException - statisticSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - statisticSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getStatisticQueryFromInspector

StatisticQuery getStatisticQueryFromInspector(StatisticQueryInspector statisticQueryInspector)

Gets a statistic query from an inspector.

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.