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.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getUtilityId()
Utility
Id
associated with this
session. Utility Id
associated with this sessionmandatory
- This method must be implemented. Utility getUtility() throws OperationFailedException, PermissionDeniedException
Utility
associated with this session. Utility
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartUtilities()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer smart operations. false
if smart utility methods are not
authorized, true
otherwisemandatory
- This method must be implemented. StatisticQuery getStatisticQuery()
mandatory
- This method must be implemented. StatisticSearchOrder getStatisticSearchOrder()
mandatory
- This method must be implemented. void applyStatisticQuery(StatisticQuery statisticQuery) throws OperationFailedException, PermissionDeniedException
statisticQuery
- the statistic queryNullArgumentException
- statisticQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- statisticQuery
not of this servicemandatory
- This method must be implemented. StatisticQueryInspector inspectStatisticQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyStatisticSequencing(StatisticSearchOrder statisticSearchOrder) throws OperationFailedException, PermissionDeniedException
statisticSearchOrder
- the statistic search orderNullArgumentException
- statisticSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- statisticSearchOrder
not of this servicemandatory
- This method must be implemented. StatisticQuery getStatisticQueryFromInspector(StatisticQueryInspector statisticQueryInspector)
statisticQueryInspector
- a statistic query inspectorNullArgumentException
- statisticQueryInspector
is null
UnsupportedException
- statisticQueryInspector
is not of this servicemandatory
- This method must be implemented.