Interface | osid.rules.RulesProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.rules.RulesProfile | |||
Description |
The rules manager provides access to rules sessions and
provides interoperability tests for various aspects of this
service. These methods accept a
The rules manager also provides a profile for determing the supported search types supported by this service. | ||
Method | getRulesSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | the proxy |
Return | osid.rules.RulesSession | a RulesSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRules() is false | ||
Compliance | optional | This method must be implemented if supportsRules() is
true. | |
Method | getRulesSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of an Engine |
osid.proxy.Proxy | proxy | the proxy | |
Return | osid.rules.RulesSession | a RulesSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engineId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRules() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsRules() and
supportsVisibleFederation() are true | |
Method | getRuleLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | the proxy |
Return | osid.rules.RuleLookupSession | a RuleLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRuleLookup() is false | ||
Compliance | optional | This method must be implemented if supportsRuleLookup() is
true. | |
Method | getRuleLookupSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of an Engine |
osid.proxy.Proxy | proxy | the proxy | |
Return | osid.rules.RuleLookupSession | a RuleLookupSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engineId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRuleLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsRuleLookup() and
supportsVisibleFederation() are true | |
Method | getRuleQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | the proxy |
Return | osid.rules.RuleQuerySession | a RuleQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRuleQuery() is false | ||
Compliance | optional | This method must be implemented if supportsRuleQuery() is
true. | |
Method | getRuleQuerySessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of an Engine |
osid.proxy.Proxy | proxy | the proxy | |
Return | osid.rules.RuleQuerySession | a RuleQuerySession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engineId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRuleQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsRuleQuery() and
supportsVisibleFederation() are true | |
Method | getRuleSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | the proxy |
Return | osid.rules.RuleSearchSession | a RuleSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRuleSearch() is false | ||
Compliance | optional | This method must be implemented if supportsRuleSearch() is
true. | |
Method | getRuleSearchSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of an Engine |
osid.proxy.Proxy | proxy | the proxy | |
Return | osid.rules.RuleSearchSession | a RuleSearchSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engindId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRuleSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsRuleSearch() and
supportsVisibleFederation() are true | |
Method | getRuleAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | the proxy |
Return | osid.rules.RuleAdminSession | a RuleAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRuleAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRuleAdmin() is
true. | |
Method | getRuleAdminSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Rule |
osid.proxy.Proxy | proxy | the proxy | |
Return | osid.rules.RuleAdminSession | a RuleAdminSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engindId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRuleAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsRuleAdmin() and
supportsVisibleFederation() are true | |
Method | getRuleNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.rules.RuleReceiver | ruleReceiver | the receiver |
osid.proxy.Proxy | proxy | the proxy | |
Return | osid.rules.RuleNotificationSession | a RuleNotificationSession | |
Errors | NULL_ARGUMENT | ruleReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRuleNotification() is false | ||
Compliance | optional | This method must be implemented if supportsRuleNotification()
is true. | |
Method | getRuleNotificationSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.rules.RuleReceiver | ruleReceiver | the receiver |
osid.id.Id | engineId | the Id of an Engine | |
osid.proxy.Proxy | proxy | the proxy | |
Return | osid.rules.RuleNotificationSession | a RuleNotificationSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | ruleReceiver, engineId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRuleNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRuleNotification()
and supportsVisibleFederation() are true | |
Method | getRuleEngineSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | the proxy |
Return | osid.rules.RuleEngineSession | a RuleEngineSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRuleEngine() is false | ||
Compliance | optional | This method must be implemented if supportsRuleEngine() is
true. | |
Method | getRuleEngineAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | the proxy |
Return | osid.rules.RuleEngineAssignmentSession | a RuleEngineAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRuleEngineAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsRuleEngineAssignment()
is true. | |
Method | getRuleSmartEngineSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Rule |
osid.proxy.Proxy | proxy | the proxy | |
Return | osid.rules.RuleSmartEngineSession | a RuleSmartEngineSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engindId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRuleSmartEngine() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRuleSmartEngine()
and supportsVisibleFederation() are true | |
Method | getEngineLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | the proxy |
Return | osid.rules.EngineLookupSession | an EngineLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEngineLookup() is false | ||
Compliance | optional | This method must be implemented if supportsEngineLookup() is
true. | |
Method | getEngineQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | the proxy |
Return | osid.rules.EngineQuerySession | an EngineQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEngineQuery() is false | ||
Compliance | optional | This method must be implemented if supportsEngineQuery() is
true. | |
Method | getEngineSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | the proxy |
Return | osid.rules.EngineSearchSession | an EngineSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEngineSearch() is false | ||
Compliance | optional | This method must be implemented if supportsEngineSearch() is
true. | |
Method | getEngineAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | the proxy |
Return | osid.rules.EngineAdminSession | an EngineAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEngineAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsEngineAdmin() is
true. | |
Method | getEngineNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.rules.EngineReceiver | engineReceiver | the receiver |
osid.proxy.Proxy | proxy | the proxy | |
Return | osid.rules.EngineNotificationSession | an EngineNotificationSession | |
Errors | NULL_ARGUMENT | engineReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEngineNotification() is false | ||
Compliance | optional | This method must be implemented if supportsEngineNotification()
is true. | |
Method | getEngineHierarchySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | the proxy |
Return | osid.rules.EngineHierarchySession | an EngineHierarchySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEngineHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsEngineHierarchy()
is true. | |
Method | getEngineHierarchyDesignSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | the proxy |
Return | osid.rules.EngineHierarchyDesignSession | an EngineHierarchyDesignSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEngineHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsEngineHierarchyDesign()
is true. | |
Method | getRulesCheckProxyManager | ||
Description |
Gets the | ||
Return | osid.rules.check.RulesCheckProxyManager | a RulesCheckProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRulesCheckManager() is false | ||
Compliance | optional | This method must be implemented if supportsRulesCheckManager()
is true. |