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.
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. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
RulesSession getRulesSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the rule
evaluation service.proxy
- the proxy RulesSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRules()
is false
optional
- This method must be implemented if
supportsRules()
is true.
RulesSession getRulesSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the rule
evaluation service for the given engine.engineId
- the Id
of an Engine
proxy
- the proxy RulesSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRules()
or supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRules()
and
supportsVisibleFederation()
are true
RuleLookupSession getRuleLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the rule lookup
service.proxy
- the proxy RuleLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRuleLookup()
is false
optional
- This method must be implemented if
supportsRuleLookup()
is true.
RuleLookupSession getRuleLookupSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the rule lookup
service for the given engine.engineId
- the Id
of an Engine
proxy
- the proxy RuleLookupSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRuleLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRuleLookup()
and
supportsVisibleFederation()
are true
RuleQuerySession getRuleQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the rule query
service.proxy
- the proxy RuleQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRuleQuery()
is false
optional
- This method must be implemented if
supportsRuleQuery()
is true.
RuleQuerySession getRuleQuerySessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the rule query
service for the given engine.engineId
- the Id
of an Engine
proxy
- the proxy RuleQuerySession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRuleQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRuleQuery()
and
supportsVisibleFederation()
are true
RuleSearchSession getRuleSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the rule search
service.proxy
- the proxy RuleSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRuleSearch()
is false
optional
- This method must be implemented if
supportsRuleSearch()
is true.
RuleSearchSession getRuleSearchSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the rule search
service for the given engine.engineId
- the Id
of an Engine
proxy
- the proxy RuleSearchSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engindId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRuleSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRuleSearch()
and
supportsVisibleFederation()
are true
RuleAdminSession getRuleAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the rule
administration service.proxy
- the proxy RuleAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRuleAdmin()
is false
optional
- This method must be implemented if
supportsRuleAdmin()
is true.
RuleAdminSession getRuleAdminSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the rule
administration service for the given engine.engineId
- the Id
of the Rule
proxy
- the proxy RuleAdminSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engindId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRuleAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRuleAdmin()
and
supportsVisibleFederation()
are true
RuleNotificationSession getRuleNotificationSession(RuleReceiver ruleReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the rule
notification service.ruleReceiver
- the receiverproxy
- the proxy RuleNotificationSession
NullArgumentException
- ruleReceiver
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRuleNotification()
is false
optional
- This method must be implemented if
supportsRuleNotification()
is true.
RuleNotificationSession getRuleNotificationSessionForEngine(RuleReceiver ruleReceiver, Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the rule
notification service for the given engine.ruleReceiver
- the receiverengineId
- the Id
of an Engine
proxy
- the proxy RuleNotificationSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- ruleReceiver, engineId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRuleNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRuleNotification()
and
supportsVisibleFederation()
are true
RuleEngineSession getRuleEngineSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup rule/engine mappings.proxy
- the proxy RuleEngineSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRuleEngine()
is false
optional
- This method must be implemented if
supportsRuleEngine()
is true.
RuleEngineAssignmentSession getRuleEngineAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning rules to
engines.proxy
- the proxy RuleEngineAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRuleEngineAssignment()
is false
optional
- This method must be implemented if
supportsRuleEngineAssignment()
is true.
RuleSmartEngineSession getRuleSmartEngineSession(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the rule smart
engine service for the given engine.engineId
- the Id
of the Rule
proxy
- the proxy RuleSmartEngineSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engindId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRuleSmartEngine()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRuleSmartEngine()
and
supportsVisibleFederation()
are true
EngineLookupSession getEngineLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the engine lookup
service.proxy
- the proxy EngineLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEngineLookup()
is false
optional
- This method must be implemented if
supportsEngineLookup()
is true.
EngineQuerySession getEngineQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the engine query
service.proxy
- the proxy EngineQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEngineQuery()
is false
optional
- This method must be implemented if
supportsEngineQuery()
is true.
EngineSearchSession getEngineSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the engine search
service.proxy
- the proxy EngineSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEngineSearch()
is false
optional
- This method must be implemented if
supportsEngineSearch()
is true.
EngineAdminSession getEngineAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the engine
administrative service.proxy
- the proxy EngineAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEngineAdmin()
is false
optional
- This method must be implemented if
supportsEngineAdmin()
is true.
EngineNotificationSession getEngineNotificationSession(EngineReceiver engineReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the engine
notification service.engineReceiver
- the receiverproxy
- the proxy EngineNotificationSession
NullArgumentException
- engineReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEngineNotification()
is false
optional
- This method must be implemented if
supportsEngineNotification()
is true.
EngineHierarchySession getEngineHierarchySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the engine
hierarchy service.proxy
- the proxy EngineHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEngineHierarchy()
is false
optional
- This method must be implemented if
supportsEngineHierarchy()
is true.
EngineHierarchyDesignSession getEngineHierarchyDesignSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the engine
hierarchy design service.proxy
- the proxy EngineHierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEngineHierarchyDesign()
is false
optional
- This method must be implemented if
supportsEngineHierarchyDesign()
is true.
RulesCheckProxyManager getRulesCheckProxyManager() throws OperationFailedException
RulesCheckProxyManager.
RulesCheckProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRulesCheckManager()
is false
optional
- This method must be implemented if
supportsRulesCheckManager()
is true.