OSID Logo
OSID Specifications
rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.RulesProxyManager
Implementsosid.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 Proxy. The sessions included in this manager are:

  • RulesSession: a session for evaluating and executing rules
  • RuleLookupSession: a session to lookup rules
  • RuleSearchSession: a session to query rules
  • RuleSearchSession: a session to search rules
  • RuleAdminSession: a session to manage rules
  • RuleNotificationSession: a session to subscribe to notifications of new rules
  • RuleEngineSession a session to retrieve rule engine mappings
  • RuleEngineAssignmentSession a session to manage rule engine mappings
  • RuleSmartEngineSession a session to manage dynamic engines
  • EngineLookupSession: a session to retrieve engine objects
  • EngineSearchSession: a session to query engines
  • EngineSearchSession: a session to search for engines
  • EngineAdminSession: a session to create, update and delete engines
  • EngineNotificationSession: a session to receive notifications for changes in engines
  • EngineHierarchyTraversalSession: a session to traverse hierarchies of engines
  • EngineHierarchyDesignSession: a session to manage hierarchies of engines

The rules manager also provides a profile for determing the supported search types supported by this service.

MethodgetRulesSession
Description

Gets the OsidSession associated with the rule evaluation service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.rules.RulesSessiona RulesSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRules() is false
ComplianceoptionalThis method must be implemented if supportsRules() is true.
MethodgetRulesSessionForEngine
Description

Gets the OsidSession associated with the rule evaluation service for the given engine.

Parametersosid.id.IdengineIdthe Id of an Engine
osid.proxy.Proxyproxythe proxy
Returnosid.rules.RulesSessiona RulesSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRules() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRules() and supportsVisibleFederation() are true
MethodgetRuleLookupSession
Description

Gets the OsidSession associated with the rule lookup service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.rules.RuleLookupSessiona RuleLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsRuleLookup() is true.
MethodgetRuleLookupSessionForEngine
Description

Gets the OsidSession associated with the rule lookup service for the given engine.

Parametersosid.id.IdengineIdthe Id of an Engine
osid.proxy.Proxyproxythe proxy
Returnosid.rules.RuleLookupSessiona RuleLookupSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRuleLookup() and supportsVisibleFederation() are true
MethodgetRuleQuerySession
Description

Gets the OsidSession associated with the rule query service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.rules.RuleQuerySessiona RuleQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRuleQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuleQuery() is true.
MethodgetRuleQuerySessionForEngine
Description

Gets the OsidSession associated with the rule query service for the given engine.

Parametersosid.id.IdengineIdthe Id of an Engine
osid.proxy.Proxyproxythe proxy
Returnosid.rules.RuleQuerySessiona RuleQuerySession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRuleQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRuleQuery() and supportsVisibleFederation() are true
MethodgetRuleSearchSession
Description

Gets the OsidSession associated with the rule search service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.rules.RuleSearchSessiona RuleSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRuleSearch() is false
ComplianceoptionalThis method must be implemented if supportsRuleSearch() is true.
MethodgetRuleSearchSessionForEngine
Description

Gets the OsidSession associated with the rule search service for the given engine.

Parametersosid.id.IdengineIdthe Id of an Engine
osid.proxy.Proxyproxythe proxy
Returnosid.rules.RuleSearchSessiona RuleSearchSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engindId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRuleSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRuleSearch() and supportsVisibleFederation() are true
MethodgetRuleAdminSession
Description

Gets the OsidSession associated with the rule administration service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.rules.RuleAdminSessiona RuleAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRuleAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRuleAdmin() is true.
MethodgetRuleAdminSessionForEngine
Description

Gets the OsidSession associated with the rule administration service for the given engine.

Parametersosid.id.IdengineIdthe Id of the Rule
osid.proxy.Proxyproxythe proxy
Returnosid.rules.RuleAdminSessiona RuleAdminSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engindId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRuleAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRuleAdmin() and supportsVisibleFederation() are true
MethodgetRuleNotificationSession
Description

Gets the OsidSession associated with the rule notification service.

Parametersosid.rules.RuleReceiverruleReceiverthe receiver
osid.proxy.Proxyproxythe proxy
Returnosid.rules.RuleNotificationSessiona RuleNotificationSession
ErrorsNULL_ARGUMENT ruleReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRuleNotification() is false
ComplianceoptionalThis method must be implemented if supportsRuleNotification() is true.
MethodgetRuleNotificationSessionForEngine
Description

Gets the OsidSession associated with the rule notification service for the given engine.

Parametersosid.rules.RuleReceiverruleReceiverthe receiver
osid.id.IdengineIdthe Id of an Engine
osid.proxy.Proxyproxythe proxy
Returnosid.rules.RuleNotificationSessiona RuleNotificationSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT ruleReceiver, engineId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRuleNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRuleNotification() and supportsVisibleFederation() are true
MethodgetRuleEngineSession
Description

Gets the OsidSession to lookup rule/engine mappings.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.rules.RuleEngineSessiona RuleEngineSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRuleEngine() is false
ComplianceoptionalThis method must be implemented if supportsRuleEngine() is true.
MethodgetRuleEngineAssignmentSession
Description

Gets the OsidSession associated with assigning rules to engines.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.rules.RuleEngineAssignmentSessiona RuleEngineAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRuleEngineAssignment() is false
ComplianceoptionalThis method must be implemented if supportsRuleEngineAssignment() is true.
MethodgetRuleSmartEngineSession
Description

Gets the OsidSession associated with the rule smart engine service for the given engine.

Parametersosid.id.IdengineIdthe Id of the Rule
osid.proxy.Proxyproxythe proxy
Returnosid.rules.RuleSmartEngineSessiona RuleSmartEngineSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engindId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRuleSmartEngine() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRuleSmartEngine() and supportsVisibleFederation() are true
MethodgetEngineLookupSession
Description

Gets the OsidSession associated with the engine lookup service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.rules.EngineLookupSessionan EngineLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineLookup() is false
ComplianceoptionalThis method must be implemented if supportsEngineLookup() is true.
MethodgetEngineQuerySession
Description

Gets the OsidSession associated with the engine query service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.rules.EngineQuerySessionan EngineQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineQuery() is false
ComplianceoptionalThis method must be implemented if supportsEngineQuery() is true.
MethodgetEngineSearchSession
Description

Gets the OsidSession associated with the engine search service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.rules.EngineSearchSessionan EngineSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineSearch() is false
ComplianceoptionalThis method must be implemented if supportsEngineSearch() is true.
MethodgetEngineAdminSession
Description

Gets the OsidSession associated with the engine administrative service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.rules.EngineAdminSessionan EngineAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineAdmin() is false
ComplianceoptionalThis method must be implemented if supportsEngineAdmin() is true.
MethodgetEngineNotificationSession
Description

Gets the OsidSession associated with the engine notification service.

Parametersosid.rules.EngineReceiverengineReceiverthe receiver
osid.proxy.Proxyproxythe proxy
Returnosid.rules.EngineNotificationSessionan EngineNotificationSession
ErrorsNULL_ARGUMENT engineReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineNotification() is false
ComplianceoptionalThis method must be implemented if supportsEngineNotification() is true.
MethodgetEngineHierarchySession
Description

Gets the OsidSession associated with the engine hierarchy service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.rules.EngineHierarchySessionan EngineHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsEngineHierarchy() is true.
MethodgetEngineHierarchyDesignSession
Description

Gets the OsidSession associated with the engine hierarchy design service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.rules.EngineHierarchyDesignSessionan EngineHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsEngineHierarchyDesign() is true.
MethodgetRulesCheckProxyManager
Description

Gets the RulesCheckProxyManager.

Returnosid.rules.check.RulesCheckProxyManagera RulesCheckProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRulesCheckManager() is false
ComplianceoptionalThis method must be implemented if supportsRulesCheckManager() is true.