Interface RulesManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, 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:

• RuleEvaluationSession : 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

Modifier and Type	Method	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.
RuleEvaluationSession	getRuleEvaluationSession()	Gets the OsidSession associated with the rule evaluation service.
RuleEvaluationSession	getRuleEvaluationSessionForEngine(Id engineId)	Gets the OsidSession associated with the rule evaluation service for the given engine.
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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface RulesProfile

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

Modifier and Type	Method	Description
TypeList	getEngineRecordTypes()	Gets the supported Engine record types.
TypeList	getEngineSearchRecordTypes()	Gets the supported engine search record types.
TypeList	getRuleRecordTypes()	Gets the supported Rule record types.
TypeList	getRuleSearchRecordTypes()	Gets the supported rule search record types.
boolean	supportsEngineAdmin()	Tests for the availability of an engine administrative service for creating and deleting engines.
boolean	supportsEngineHierarchy()	Tests for the availability of an engine hierarchy traversal service.
boolean	supportsEngineHierarchyDesign()	Tests for the availability of an engine hierarchy design service.
boolean	supportsEngineLookup()	Tests for the availability of an engine lookup service.
boolean	supportsEngineNotification()	Tests for the availability of an engine notification service.
boolean	supportsEngineQuery()	Tests for the availability of an engine query service.
boolean	supportsEngineRecordType(Type engineRecordType)	Tests if the given Engine record type is supported.
boolean	supportsEngineSearch()	Tests if searching for engines is available.
boolean	supportsEngineSearchRecordType(Type engineSearchRecordType)	Tests if the given engine search record type is supported.
boolean	supportsRuleAdmin()	Tests if managing rules is available.
boolean	supportsRuleEngine()	Tests if rule cataloging is available.
boolean	supportsRuleEngineAssignment()	Tests if a rule cataloging assignment service is supported.
boolean	supportsRuleEvaluation()	Tests if rule evaluation is supported.
boolean	supportsRuleLookup()	Tests for the availability of a rule lookup service.
boolean	supportsRuleNotification()	Tests if rule notification is available.
boolean	supportsRuleQuery()	Tests if querying rules is available.
boolean	supportsRuleRecordType(Type ruleRecordType)	Tests if the given Rule record type is supported.
boolean	supportsRulesCheck()	Tests for the availability of a rules check service.
boolean	supportsRuleSearch()	Tests if searching for rules is available.
boolean	supportsRuleSearchRecordType(Type ruleSearchRecordType)	Tests if the given rule search record type is supported.
boolean	supportsRuleSmartEngine()	Tests if rule smart engines is available.
boolean	supportsVisibleFederation()	Tests if any engine federation is exposed.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getRuleEvaluationSession

RuleEvaluationSession getRuleEvaluationSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the rule evaluation service.

Returns:

a RuleEvaluationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleEvaluation() is false

Compliance:

optional - This method must be implemented if {@code supportsRuleEvaluation()} is {@code true} .

getRuleEvaluationSessionForEngine

RuleEvaluationSession getRuleEvaluationSessionForEngine(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 RuleEvaluationSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRuleEvaluation() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRuleEvaluation()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRuleLookup()} is {@code 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 {@code supportsRuleLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRuleQuery()} is {@code 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 {@code supportsRuleQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRuleSearch()} is {@code 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 {@code supportsRuleSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRuleAdmin()} is {@code 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 {@code supportsRuleAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRuleNotification()} is {@code 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 {@code supportsRuleNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRuleEngine()} is {@code 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 {@code supportsRuleEngineAssignment()} is {@code 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 {@code supportsRuleSmartEngine()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEngineLookup()} is {@code 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 {@code supportsEngineQuery()} is {@code 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 {@code supportsEngineSearch()} is {@code 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 {@code supportsEngineAdmin()} is {@code 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 {@code supportsEngineNotification()} is {@code 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 {@code supportsEngineHierarchy()} is {@code 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 {@code supportsEngineHierarchyDesign()} is {@code 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 {@code supportsRulesCheckManager()} is {@code true} .