public interface CheckSmartEngineSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CheckQuery
can be retrieved from this session
and engineped to this Engine
to create a virtual collection
of Checks.
The checks may be sequenced using the
CheckSearchOrder
from this session.
This Engine
has a default query that matches any check
and a default search order that specifies no sequencing. The queries may
be examined using a CheckQueryInspector.
The query may be
modified by converting the inspector back to a CheckQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCheckQuery(CheckQuery checkQuery)
Applies a check query to this engine.
|
void |
applyCheckSequencing(CheckSearchOrder checkSearchOrder)
Applies a check search order to this engine.
|
boolean |
canManageSmartEngines()
Tests if this user can manage smart engines.
|
CheckQuery |
getCheckQuery()
Gets a check query.
|
CheckQuery |
getCheckQueryFromInspector(CheckQueryInspector checkQueryInspector)
Gets a check query from an inspector.
|
CheckSearchOrder |
getCheckSearchOrder()
Gets a check search order.
|
Engine |
getEngine()
Gets the
Engine associated with this session. |
Id |
getEngineId()
Gets the
Engine Id associated with this
session. |
CheckQueryInspector |
inspectCheckQuery()
Gets a check query inspector for this engine.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getEngineId()
Engine
Id
associated with this
session. Engine Id
associated with this sessionmandatory
- This method must be implemented. Engine getEngine() throws OperationFailedException, PermissionDeniedException
Engine
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartEngines()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart engine management is not
authorized, true
otherwisemandatory
- This method must be implemented. CheckQuery getCheckQuery()
mandatory
- This method must be implemented. CheckSearchOrder getCheckSearchOrder()
mandatory
- This method must be implemented. void applyCheckQuery(CheckQuery checkQuery) throws OperationFailedException, PermissionDeniedException
checkQuery
- the check queryNullArgumentException
- checkQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- checkQuery
not of
this servicemandatory
- This method must be implemented. CheckQueryInspector inspectCheckQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCheckSequencing(CheckSearchOrder checkSearchOrder) throws OperationFailedException, PermissionDeniedException
checkSearchOrder
- the check search orderNullArgumentException
- checkSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- checkSearchOrder
not of this servicemandatory
- This method must be implemented. CheckQuery getCheckQueryFromInspector(CheckQueryInspector checkQueryInspector)
checkQueryInspector
- a check query inspectorNullArgumentException
- checkQueryInspector
is null
UnsupportedException
- checkQueryInspector
is not of this servicemandatory
- This method must be implemented.