OSID - osid.rules.RulesManager Service Interface Definition

Interface	osid.rules.RulesManager
Implements	`osid.OsidManager`
Implements	`osid.rules.RulesProfile`
Description	The rules manager provides access to rules sessions and provides interoperability tests for various aspects of this service. 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.
Method	getRulesSession
Description	Gets the `OsidSession` associated with the rule evaluation service.
Return	`osid.rules.RulesSession`		a `RulesSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRules()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuleEvaluation()` is `true.`
Method	getRulesSessionForEngine
Description	Gets the `OsidSession` associated with the rule evaluation service for the given engine.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an `Engine`
Return	`osid.rules.RulesSession`		a `RulesSession`
Errors	NOT_FOUND		no `Engine` found by the given `Id`
	NULL_ARGUMENT		`engineId` 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 `OsidSession` associated with the rule lookup service.
Return	`osid.rules.RuleLookupSession`		a `RuleLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRuleLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuleLookup()` is `true.`
Method	getRuleLookupSessionForEngine
Description	Gets the `OsidSession` associated with the rule lookup service for the given engine.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an `Engine`
Return	`osid.rules.RuleLookupSession`		a `RuleLookupSession`
Errors	NOT_FOUND		no `Engine` found by the given `Id`
	NULL_ARGUMENT		`engineId` 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 `OsidSession` associated with the rule query service.
Return	`osid.rules.RuleQuerySession`		a `RuleQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRuleQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuleQuery()` is `true.`
Method	getRuleQuerySessionForEngine
Description	Gets the `OsidSession` associated with the rule query service for the given engine.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an `Engine`
Return	`osid.rules.RuleQuerySession`		a `RuleQuerySession`
Errors	NOT_FOUND		no `Engine` found by the given `Id`
	NULL_ARGUMENT		`engineId` 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 `OsidSession` associated with the rule search service.
Return	`osid.rules.RuleSearchSession`		a `RuleSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRuleSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuleSearch()` is `true.`
Method	getRuleSearchSessionForEngine
Description	Gets the `OsidSession` associated with the rule search service for the given engine.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an `Engine`
Return	`osid.rules.RuleSearchSession`		a `RuleSearchSession`
Errors	NOT_FOUND		no `Engine` found by the given `Id`
	NULL_ARGUMENT		`engineId` 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 `OsidSession` associated with the rule administrative service.
Return	`osid.rules.RuleAdminSession`		a `RuleAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRuleAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuleAdmin()` is `true.`
Method	getRuleAdminSessionForEngine
Description	Gets the `OsidSession` associated with the rule administrative service for the given engine.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an `Engine`
Return	`osid.rules.RuleAdminSession`		a `RuleAdminSession`
Errors	NOT_FOUND		no `Engine` found by the given `Id`
	NULL_ARGUMENT		`engineId` 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 `OsidSession` associated with the rule notification service.
Parameters	`osid.rules.RuleReceiver`	`ruleReceiver`	the receiver
Return	`osid.rules.RuleNotificationSession`		a `RuleNotificationSession`
Errors	NULL_ARGUMENT		`ruleReceiver` 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 `OsidSession` associated with the rule notification service for the given engine.
Parameters	`osid.rules.RuleReceiver`	`ruleReceiver`	the receiver
Parameters	`osid.id.Id`	`engineId`	the `Id` of an `Engine`
Return	`osid.rules.RuleNotificationSession`		a `RuleNotificationSession`
Errors	NOT_FOUND		no `Rule` found by the given `Id`
	NULL_ARGUMENT		`ruleReceiver` or `engineId` 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 `OsidSession` to lookup rule/engine mappings.
Return	`osid.rules.RuleEngineSession`		a `RuleEngineSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRuleEngine()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuleEngine()` is `true.`
Method	getRuleEngineAssignmentSession
Description	Gets the `OsidSession` associated with assigning rules to engines.
Return	`osid.rules.RuleEngineAssignmentSession`		a `RuleEngineAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRuleEngineAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuleEngineAssignment()` is `true.`
Method	getRuleSmartEngineSession
Description	Gets the `OsidSession` associated with the rule smart engine service for the given engine.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an `Engine`
Return	`osid.rules.RuleSmartEngineSession`		a `RuleSmartEngineSession`
Errors	NOT_FOUND		no `Engine` found by the given `Id`
	NULL_ARGUMENT		`engineId` 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 `OsidSession` associated with the engine lookup service.
Return	`osid.rules.EngineLookupSession`		an `EngineLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEngineLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineLookup()` is `true.`
Method	getEngineQuerySession
Description	Gets the `OsidSession` associated with the engine query service.
Return	`osid.rules.EngineQuerySession`		an `EngineQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEngineQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineQuery()` is `true.`
Method	getEngineSearchSession
Description	Gets the `OsidSession` associated with the engine search service.
Return	`osid.rules.EngineSearchSession`		an `EngineSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEngineSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineSearch()` is `true.`
Method	getEngineAdminSession
Description	Gets the `OsidSession` associated with the engine administrative service.
Return	`osid.rules.EngineAdminSession`		an `EngineAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEngineAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineAdmin()` is `true.`
Method	getEngineNotificationSession
Description	Gets the `OsidSession` associated with the engine notification service.
Parameters	`osid.rules.EngineReceiver`	`engineReceiver`	the receiver
Return	`osid.rules.EngineNotificationSession`		an `EngineNotificationSession`
Errors	NULL_ARGUMENT		`engineReceiver` 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 `OsidSession` associated with the engine hierarchy service.
Return	`osid.rules.EngineHierarchySession`		an `EngineHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEngineHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineHierarchy()` is `true.`
Method	getEngineHierarchyDesignSession
Description	Gets the `OsidSession` associated with the engine hierarchy design service.
Return	`osid.rules.EngineHierarchyDesignSession`		an `EngineierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEngineHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineHierarchyDesign()` is `true.`
Method	getRulesCheckManager
Description	Gets the `RulesCheckManager.`
Return	`osid.rules.check.RulesCheckManager`		a `RulesCheckManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRulesCheckManager()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRulesCheckManager()` is `true.`