public interface RuleSmartEngineSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A RuleQuery
can be retrieved from this session
and mapped to this Engine
to create a virtual collection of
Rules.
The rules may be sequenced using the
RuleSearchOrder
from this session.
This Engine
has a default query that matches any rule
and a default search order that specifies no sequencing. The queries may
be examined using a RuleQueryInspector.
The query may be
modified by converting the inspector back to a RuleQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyRuleQuery(RuleQuery ruleQuery)
Applies a rule query to this engine.
|
void |
applyRuleSequencing(RuleSearchOrder ruleSearchOrder)
Applies a rule search order to this engine.
|
boolean |
canManageSmartEngines()
Tests if this user can manage smart engines.
|
Engine |
getEngine()
Gets the
Engine associated with this session. |
Id |
getEngineId()
Gets the
Engine Id associated with this
session. |
RuleQuery |
getRuleQuery()
Gets a rule query.
|
RuleQuery |
getRuleQueryFromInspector(RuleQueryInspector ruleQueryInspector)
Gets a rule query from an inspector.
|
RuleSearchOrder |
getRuleSearchOrder()
Gets a rule search order.
|
RuleQueryInspector |
inspectRuleQuery()
Gets a rule 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. Engine
associated with this sessionOperationFailedException
- 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. RuleQuery getRuleQuery()
mandatory
- This method must be implemented. RuleSearchOrder getRuleSearchOrder()
mandatory
- This method must be implemented. void applyRuleQuery(RuleQuery ruleQuery) throws OperationFailedException, PermissionDeniedException
ruleQuery
- the rule queryNullArgumentException
- ruleQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- ruleQuery
not of
this servicemandatory
- This method must be implemented. RuleQueryInspector inspectRuleQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyRuleSequencing(RuleSearchOrder ruleSearchOrder) throws OperationFailedException, PermissionDeniedException
ruleSearchOrder
- the rule search orderNullArgumentException
- ruleSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- ruleSearchOrder
not of this servicemandatory
- This method must be implemented. RuleQuery getRuleQueryFromInspector(RuleQueryInspector ruleQueryInspector)
ruleQueryInspector
- a rule query inspectorNullArgumentException
- ruleQueryInspector
is null
UnsupportedException
- ruleQueryInspector
is not of this servicemandatory
- This method must be implemented.