com.beasys.commerce.axiom.reasoning.rules.serviceProvider
Interface ServiceProvider

All Known Implementing Classes:

JRulesServiceProvider

public interface ServiceProvider

Specifies the behavior for a rules engine service provider.

Method Summary

boolean	acceptsURI(java.lang.String rulesetURI) Determines whether or not the service provider can create a ruleset for the given rule set uri.
Context	createContext(java.lang.String rulesetURI) Creates a context for the given rule set uri
void	createRuleset(java.lang.String rulesetURI, java.io.InputStream ruleStream) Creates a rule set for the given input stream
RulesetBuilder	createRulesetBuilder() Creates a new rule set builder
java.lang.String	getID() Gets the service provider's id
int	getMajorVersion() Gets the service provider's major version number.
int	getMinorVersion() Gets the service provider's minor version number.
void	releaseAllRulesets() Releases all rule sets
void	releaseRuleset(java.lang.String rulesetURI) Releases a ruleset
void	releaseUnusedRulesets() Releases all rule sets that are not in use

Method Detail

acceptsURI

public boolean acceptsURI(java.lang.String rulesetURI)
                   throws java.lang.IllegalArgumentException

Determines whether or not the service provider can create a ruleset for the given rule set uri.

Parameters:

rulesetURI - The uri of the rule set

Throws:

java.lang.IllegalArgumentException - Thrown if rulesetURI is null or zero-length

createContext

public Context createContext(java.lang.String rulesetURI)
                      throws ServiceProviderException

Creates a context for the given rule set uri

Parameters:

rulesetURI - The rule set uri for which a context is to be created

Returns:

The new context or null if there is no rule set for the uri

Throws:

java.lang.IllegalArgumentException - Thrown if rulesetURI is null or zero-length

ServiceProviderException - Thrown if unable to create the context

createRuleset

public void createRuleset(java.lang.String rulesetURI,
                          java.io.InputStream ruleStream)
                   throws java.lang.IllegalArgumentException,
                          ServiceProviderException

Creates a rule set for the given input stream

Parameters:

rulesetURI - The rule set uri to be mapped to the resultant rule set

ruleStream - A stream of rules expressed in the vendor-specific language

Throws:

java.lang.IllegalArgumentException - Thrown if rulesetURI is null or zero-length, or if ruleStream is null

ServiceProviderException - Thrown if unable to create the rule set

createRulesetBuilder

public RulesetBuilder createRulesetBuilder()
                                    throws java.lang.IllegalArgumentException,
                                           ServiceProviderException

Creates a new rule set builder

Throws:

ServiceProviderException - Thrown if unable to create the builder

getID

public java.lang.String getID()

Gets the service provider's id

Returns:

The id

getMajorVersion

public int getMajorVersion()

Gets the service provider's major version number.

Returns:

The major version number

getMinorVersion

public int getMinorVersion()

Gets the service provider's minor version number.

Returns:

The minor version number

releaseAllRulesets

public void releaseAllRulesets()
                        throws ServiceProviderException

Releases all rule sets

Throws:

ServiceProviderException - Thrown if unable to release all rule sets

releaseRuleset

public void releaseRuleset(java.lang.String rulesetURI)
                    throws java.lang.IllegalArgumentException,
                           ServiceProviderException

Releases a ruleset

Parameters:

rulesetURI - The url of the rule set to be released

Throws:

java.lang.IllegalArgumentException - Thrown if rulesetURI is null or zero-length

ServiceProviderException - Thrown if unable to release the rule set

releaseUnusedRulesets

public void releaseUnusedRulesets()
                           throws ServiceProviderException

Releases all rule sets that are not in use

Throws:

ServiceProviderException - Thrown if unable to release unused rule sets