Interface | osid.rules.RuleSmartEngineSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getEngineId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Engine Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getEngine | ||
Description |
Gets the | ||
Return | osid.rules.Engine | the Engine associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartEngines | ||
Description |
Tests if this user can manage smart engines. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart engine management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuleQuery | ||
Description |
Gets a rule query. | ||
Return | osid.rules.RuleQuery | the rule query | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuleSearchOrder | ||
Description |
Gets a rule search order. | ||
Return | osid.rules.RuleSearchOrder | the rule search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyRuleQuery | ||
Description |
Applies a rule query to this engine. | ||
Parameters | osid.rules.RuleQuery | ruleQuery | the rule query |
Errors | NULL_ARGUMENT | ruleQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | ruleQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectRuleQuery | ||
Description |
Gets a rule query inspector for this engine. | ||
Return | osid.rules.RuleQueryInspector | the rule query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyRuleSequencing | ||
Description |
Applies a rule search order to this engine. | ||
Parameters | osid.rules.RuleSearchOrder | ruleSearchOrder | the rule search order |
Errors | NULL_ARGUMENT | ruleSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | ruleSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRuleQueryFromInspector | ||
Description |
Gets a rule query from an inspector. | ||
Parameters | osid.rules.RuleQueryInspector | ruleQueryInspector | a rule query inspector |
Return | osid.rules.RuleQuery | the rule query | |
Errors | NULL_ARGUMENT | ruleQueryInspector is null | |
UNSUPPORTED | ruleQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |