org.osid.rules

Interface RulesManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, RulesProfile, Sourceable

public interface RulesManager
extends OsidManager, RulesProfile

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 Summary

Methods

Modifier and Type	Method and Description
EngineAdminSession	getEngineAdminSession() Gets the OsidSession associated with the engine administrative service.
EngineHierarchyDesignSession	getEngineHierarchyDesignSession() Gets the OsidSession associated with the engine hierarchy design service.
EngineHierarchySession	getEngineHierarchySession() Gets the OsidSession associated with the engine hierarchy service.
EngineLookupSession	getEngineLookupSession() Gets the OsidSession associated with the engine lookup service.
EngineNotificationSession	getEngineNotificationSession(EngineReceiver engineReceiver) Gets the OsidSession associated with the engine notification service.
EngineQuerySession	getEngineQuerySession() Gets the OsidSession associated with the engine query service.
EngineSearchSession	getEngineSearchSession() Gets the OsidSession associated with the engine search service.
RuleAdminSession	getRuleAdminSession() Gets the OsidSession associated with the rule administrative service.
RuleAdminSession	getRuleAdminSessionForEngine(Id engineId) Gets the OsidSession associated with the rule administrative service for the given engine.
RuleEngineAssignmentSession	getRuleEngineAssignmentSession() Gets the OsidSession associated with assigning rules to engines.
RuleEngineSession	getRuleEngineSession() Gets the OsidSession to lookup rule/engine mappings.
RuleLookupSession	getRuleLookupSession() Gets the OsidSession associated with the rule lookup service.
RuleLookupSession	getRuleLookupSessionForEngine(Id engineId) Gets the OsidSession associated with the rule lookup service for the given engine.
RuleNotificationSession	getRuleNotificationSession(RuleReceiver ruleReceiver) Gets the OsidSession associated with the rule notification service.
RuleNotificationSession	getRuleNotificationSessionForEngine(RuleReceiver ruleReceiver, Id engineId) Gets the OsidSession associated with the rule notification service for the given engine.
RuleQuerySession	getRuleQuerySession() Gets the OsidSession associated with the rule query service.
RuleQuerySession	getRuleQuerySessionForEngine(Id engineId) Gets the OsidSession associated with the rule query service for the given engine.
RulesCheckManager	getRulesCheckManager() Gets the RulesCheckManager.
RuleSearchSession	getRuleSearchSession() Gets the OsidSession associated with the rule search service.
RuleSearchSession	getRuleSearchSessionForEngine(Id engineId) Gets the OsidSession associated with the rule search service for the given engine.
RuleSmartEngineSession	getRuleSmartEngineSession(Id engineId) Gets the OsidSession associated with the rule smart engine service for the given engine.
RulesSession	getRulesSession() Gets the OsidSession associated with the rule evaluation service.
RulesSession	getRulesSessionForEngine(Id engineId) Gets the OsidSession associated with the rule evaluation service for the given engine.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.rules.RulesProfile

getEngineRecordTypes, getEngineSearchRecordTypes, getRuleRecordTypes, getRuleSearchRecordTypes, supportsEngineAdmin, supportsEngineHierarchy, supportsEngineHierarchyDesign, supportsEngineLookup, supportsEngineNotification, supportsEngineQuery, supportsEngineRecordType, supportsEngineSearch, supportsEngineSearchRecordType, supportsRuleAdmin, supportsRuleEngine, supportsRuleEngineAssignment, supportsRuleLookup, supportsRuleNotification, supportsRuleQuery, supportsRuleRecordType, supportsRules, supportsRulesCheck, supportsRuleSearch, supportsRuleSearchRecordType, supportsRuleSmartEngine, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getRulesSession

RulesSession getRulesSession()
                             throws OperationFailedException

Gets the OsidSession associated with the rule evaluation service.

Returns:

a RulesSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRules() is false

Compliance:

optional - This method must be implemented if supportsRuleEvaluation() is true.

getRulesSessionForEngine

RulesSession getRulesSessionForEngine(Id engineId)
                                      throws NotFoundException,
                                             OperationFailedException

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

Parameters:

engineId - the Id of an Engine

Returns:

a RulesSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRules() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRules() and supportsVisibleFederation() are true

getRuleLookupSession

RuleLookupSession getRuleLookupSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the rule lookup service.

Returns:

a RuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsRuleLookup() is true.

getRuleLookupSessionForEngine

RuleLookupSession getRuleLookupSessionForEngine(Id engineId)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

engineId - the Id of an Engine

Returns:

a RuleLookupSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRuleLookup() and supportsVisibleFederation() are true

getRuleQuerySession

RuleQuerySession getRuleQuerySession()
                                     throws OperationFailedException

Gets the OsidSession associated with the rule query service.

Returns:

a RuleQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleQuery() is false

Compliance:

optional - This method must be implemented if supportsRuleQuery() is true.

getRuleQuerySessionForEngine

RuleQuerySession getRuleQuerySessionForEngine(Id engineId)
                                              throws NotFoundException,
                                                     OperationFailedException

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

Parameters:

engineId - the Id of an Engine

Returns:

a RuleQuerySession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRuleQuery() and supportsVisibleFederation() are true

getRuleSearchSession

RuleSearchSession getRuleSearchSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the rule search service.

Returns:

a RuleSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleSearch() is false

Compliance:

optional - This method must be implemented if supportsRuleSearch() is true.

getRuleSearchSessionForEngine

RuleSearchSession getRuleSearchSessionForEngine(Id engineId)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

engineId - the Id of an Engine

Returns:

a RuleSearchSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRuleSearch() and supportsVisibleFederation() are true

getRuleAdminSession

RuleAdminSession getRuleAdminSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the rule administrative service.

Returns:

a RuleAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleAdmin() is false

Compliance:

optional - This method must be implemented if supportsRuleAdmin() is true.

getRuleAdminSessionForEngine

RuleAdminSession getRuleAdminSessionForEngine(Id engineId)
                                              throws NotFoundException,
                                                     OperationFailedException

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

Parameters:

engineId - the Id of an Engine

Returns:

a RuleAdminSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRuleAdmin() and supportsVisibleFederation() are true

getRuleNotificationSession

RuleNotificationSession getRuleNotificationSession(RuleReceiver ruleReceiver)
                                                   throws OperationFailedException

Gets the OsidSession associated with the rule notification service.

Parameters:

ruleReceiver - the receiver

Returns:

a RuleNotificationSession

Throws:

NullArgumentException - ruleReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleNotification() is false

Compliance:

optional - This method must be implemented if supportsRuleNotification() is true.

getRuleNotificationSessionForEngine

RuleNotificationSession getRuleNotificationSessionForEngine(RuleReceiver ruleReceiver,
                                                          Id engineId)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

ruleReceiver - the receiver

engineId - the Id of an Engine

Returns:

a RuleNotificationSession

Throws:

NotFoundException - no Rule found by the given Id

NullArgumentException - ruleReceiver or engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRuleNotification() and supportsVisibleFederation() are true

getRuleEngineSession

RuleEngineSession getRuleEngineSession()
                                       throws OperationFailedException

Gets the OsidSession to lookup rule/engine mappings.

Returns:

a RuleEngineSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleEngine() is false

Compliance:

optional - This method must be implemented if supportsRuleEngine() is true.

getRuleEngineAssignmentSession

RuleEngineAssignmentSession getRuleEngineAssignmentSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with assigning rules to engines.

Returns:

a RuleEngineAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleEngineAssignment() is false

Compliance:

optional - This method must be implemented if supportsRuleEngineAssignment() is true.

getRuleSmartEngineSession

RuleSmartEngineSession getRuleSmartEngineSession(Id engineId)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

engineId - the Id of an Engine

Returns:

a RuleSmartEngineSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleSmartEngine() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRuleSmartEngine() and supportsVisibleFederation() are true

getEngineLookupSession

EngineLookupSession getEngineLookupSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the engine lookup service.

Returns:

an EngineLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineLookup() is false

Compliance:

optional - This method must be implemented if supportsEngineLookup() is true.

getEngineQuerySession

EngineQuerySession getEngineQuerySession()
                                         throws OperationFailedException

Gets the OsidSession associated with the engine query service.

Returns:

an EngineQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineQuery() is false

Compliance:

optional - This method must be implemented if supportsEngineQuery() is true.

getEngineSearchSession

EngineSearchSession getEngineSearchSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the engine search service.

Returns:

an EngineSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineSearch() is false

Compliance:

optional - This method must be implemented if supportsEngineSearch() is true.

getEngineAdminSession

EngineAdminSession getEngineAdminSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the engine administrative service.

Returns:

an EngineAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineAdmin() is false

Compliance:

optional - This method must be implemented if supportsEngineAdmin() is true.

getEngineNotificationSession

EngineNotificationSession getEngineNotificationSession(EngineReceiver engineReceiver)
                                                       throws OperationFailedException

Gets the OsidSession associated with the engine notification service.

Parameters:

engineReceiver - the receiver

Returns:

an EngineNotificationSession

Throws:

NullArgumentException - engineReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineNotification() is false

Compliance:

optional - This method must be implemented if supportsEngineNotification() is true.

getEngineHierarchySession

EngineHierarchySession getEngineHierarchySession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the engine hierarchy service.

Returns:

an EngineHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineHierarchy() is false

Compliance:

optional - This method must be implemented if supportsEngineHierarchy() is true.

getEngineHierarchyDesignSession

EngineHierarchyDesignSession getEngineHierarchyDesignSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with the engine hierarchy design service.

Returns:

an EngineierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsEngineHierarchyDesign() is true.

getRulesCheckManager

RulesCheckManager getRulesCheckManager()
                                       throws OperationFailedException

Gets the RulesCheckManager.

Returns:

a RulesCheckManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRulesCheckManager() is false

Compliance:

optional - This method must be implemented if supportsRulesCheckManager() is true.