org.osid.rules

Interface RulesProxyManager

All Superinterfaces:

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

public interface RulesProxyManager
extends OsidProxyManager, RulesProfile

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.

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                             throws OperationFailedException

Gets the OsidSession associated with the rule evaluation service.

Parameters:

proxy - the proxy

Returns:

a RulesSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRules() is false

Compliance:

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

getRulesSessionForEngine

RulesSession getRulesSessionForEngine(Id engineId,
                                    Proxy proxy)
                                      throws NotFoundException,
                                             OperationFailedException

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

Parameters:

engineId - the Id of an Engine

proxy - the proxy

Returns:

a RulesSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the rule lookup service.

Parameters:

proxy - the proxy

Returns:

a RuleLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

engineId - the Id of an Engine

proxy - the proxy

Returns:

a RuleLookupSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the rule query service.

Parameters:

proxy - the proxy

Returns:

a RuleQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                            Proxy proxy)
                                              throws NotFoundException,
                                                     OperationFailedException

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

Parameters:

engineId - the Id of an Engine

proxy - the proxy

Returns:

a RuleQuerySession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the rule search service.

Parameters:

proxy - the proxy

Returns:

a RuleSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

engineId - the Id of an Engine

proxy - the proxy

Returns:

a RuleSearchSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engindId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the rule administration service.

Parameters:

proxy - the proxy

Returns:

a RuleAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                            Proxy proxy)
                                              throws NotFoundException,
                                                     OperationFailedException

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

Parameters:

engineId - the Id of the Rule

proxy - the proxy

Returns:

a RuleAdminSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engindId or proxy 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,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the rule notification service.

Parameters:

ruleReceiver - the receiver

proxy - the proxy

Returns:

a RuleNotificationSession

Throws:

NullArgumentException - ruleReceiver or proxy 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,
                                                          Proxy proxy)
                                                            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

proxy - the proxy

Returns:

a RuleNotificationSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - ruleReceiver, engineId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession to lookup rule/engine mappings.

Parameters:

proxy - the proxy

Returns:

a RuleEngineSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleEngine() is false

Compliance:

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

getRuleEngineAssignmentSession

RuleEngineAssignmentSession getRuleEngineAssignmentSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with assigning rules to engines.

Parameters:

proxy - the proxy

Returns:

a RuleEngineAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

engineId - the Id of the Rule

proxy - the proxy

Returns:

a RuleSmartEngineSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engindId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the engine lookup service.

Parameters:

proxy - the proxy

Returns:

an EngineLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineLookup() is false

Compliance:

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

getEngineQuerySession

EngineQuerySession getEngineQuerySession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the engine query service.

Parameters:

proxy - the proxy

Returns:

an EngineQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineQuery() is false

Compliance:

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

getEngineSearchSession

EngineSearchSession getEngineSearchSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the engine search service.

Parameters:

proxy - the proxy

Returns:

an EngineSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineSearch() is false

Compliance:

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

getEngineAdminSession

EngineAdminSession getEngineAdminSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the engine administrative service.

Parameters:

proxy - the proxy

Returns:

an EngineAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the engine notification service.

Parameters:

engineReceiver - the receiver

proxy - the proxy

Returns:

an EngineNotificationSession

Throws:

NullArgumentException - engineReceiver or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the engine hierarchy service.

Parameters:

proxy - the proxy

Returns:

an EngineHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineHierarchy() is false

Compliance:

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

getEngineHierarchyDesignSession

EngineHierarchyDesignSession getEngineHierarchyDesignSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the engine hierarchy design service.

Parameters:

proxy - the proxy

Returns:

an EngineHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineHierarchyDesign() is false

Compliance:

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

getRulesCheckProxyManager

RulesCheckProxyManager getRulesCheckProxyManager()
                                                 throws OperationFailedException

Gets the RulesCheckProxyManager.

Returns:

a RulesCheckProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRulesCheckManager() is false

Compliance:

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