- get() - Method in class com.sap.brms.qrules.engine.Persistence
-
Returns persistence specific parameter.
- getAbortMessage() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Returns the message specified when the execution was aborted.
- getAliasSetName() - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
Returns the Project Alias set.
- getAssignActionEventMessages() - Method in interface com.sap.brms.qrules.engine.IEventDetails
-
Returns a String array of action event detail message that get generated
when an assign action is fired.
- getBusinessLogLevel() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Returns the level of business logging to be done for this invocation.
- getClassesUsed() - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
Returns the name of classes used in this Ruleset.
- getClassLoader() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Returns class loader configured to be used to load
Class
when engine can not
load it from the input facts or engine class loader.
- getConditionFailedEventMessages() - Method in interface com.sap.brms.qrules.engine.IEventDetails
-
Returns a String array of condition event detail messages that get
generated if a condition is not satisfied.
- getConditionSatisfiedEventMessages() - Method in interface com.sap.brms.qrules.engine.IEventDetails
-
Returns a String array of condition event detail messages that get
generated if a condition is satisfied.
- getDecisionTableEventMessages() - Method in interface com.sap.brms.qrules.engine.IEventDetails
-
Returns a String array of DecisionTable event detail as message that get
generated when a DecisionTable is evaluated.
- getDecisionTableNames() - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
This method returns the names of the DecisionTables present in this
Ruleset.
- getDefinition(String) - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
This method returns the instance of
AbstractDefinition
corresponding to the
name in the param
definitionname
.
- getDefinitionNames() - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
This method returns names of all the Definitions available within this
Ruleset.
- getEntityName() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Returns the name of the entity to be invoked using this
RulesetContext
instance.
- getEntityType() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Returns the entity type to be invoked using this
RulesetContext
instance.
- getEvaluateActionEventMessages() - Method in interface com.sap.brms.qrules.engine.IEventDetails
-
Returns a String array of action event detail message that get generated
when an 'evaluate' action is fired.
- getEventDetails() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Returns the Event details of this context.
- getEventFilter() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Returns the event filter associated with this context.
- getGUID() - Method in class com.sap.brms.qrules.engine.AbstractProject
-
This method is used to retrieve the GUID for this Project
- getGUID() - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
Returns the unique identifier of this Ruleset.
- getId() - Method in exception com.sap.brms.qrules.engine.NoSuchProjectException
-
Returns the Id of the message, If the exception is not created with an
Id, this returns a null
- getId() - Method in exception com.sap.brms.qrules.engine.NoSuchRuleException
-
Returns the Id of the message, If the exception is not created with an
Id, this returns a null
- getId() - Method in exception com.sap.brms.qrules.engine.RuleException
-
Returns the Id of the message, If the exception is not created with an
Id, this returns a null
- getId() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
The Id is invocation specific value which is generated when you create
the context.
- getInputType() - Method in class com.sap.brms.qrules.xml.XMLObject
-
Returns the input type.
- getInstance() - Static method in class com.sap.brms.qrules.engine.RuleEngineFactory
-
Returns singleton instance of RuleEngine factory.
- getInvocationId() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Returns the Id of the invocation.
- getLocation() - Method in exception com.sap.brms.qrules.engine.RuleException
-
- getName() - Method in class com.sap.brms.qrules.engine.AbstractDefinition
-
This method returns the name of this Definition
- getName() - Method in class com.sap.brms.qrules.engine.AbstractProject
-
This method can be used to retrieve the name of this Project.
- getName() - Method in class com.sap.brms.qrules.engine.AbstractRule
-
Returns the name of this Rule
- getName() - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
Returns the name of this Ruleset.
- getNameOfRuleset(String) - Method in class com.sap.brms.qrules.engine.AbstractProject
-
This method returns name of the Ruleset whose GUID matches with the GUID passed as the input parameter.
- getPreconditionNames() - Method in class com.sap.brms.qrules.engine.AbstractRule
-
If this Rule contains any preconditions, this method will return the
names of those precondition Rules in a String array.
- getPriority() - Method in class com.sap.brms.qrules.engine.AbstractRule
-
This method returns an integer value that represents the priority.
- getProject(String) - Method in interface com.sap.brms.qrules.ejb.local.RuleEngineLocal
-
- getProject(String) - Method in interface com.sap.brms.qrules.engine.RuleEngine
-
This method returns the Project identified by the name in
projectName
param.
- getProjectName() - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
Returns the name of the Project to which this Ruleset belongs
- getProjectName() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Gets the name of the Project whose Ruleset needs to be invoked.
- getProperty(String) - Method in class com.sap.brms.qrules.engine.AbstractDefinition
-
This method returns the value of the property corresponding to the
given propertyKey.
- getProperty(String) - Method in class com.sap.brms.qrules.engine.AbstractRule
-
Returns the Rule property (user defined) with the specified key.
- getProperty(String, String) - Method in class com.sap.brms.qrules.engine.AbstractRule
-
Returns the Rule property (user defined) with the specified key.
- getProperty(String) - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
Returns the value of the Ruleset property with the specified key.
- getProperty(String, String) - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
Returns the value of that Ruleset property that corresponds to the given
key.
- getPropertySet() - Method in class com.sap.brms.qrules.engine.AbstractDefinition
-
- getReturnedFacts() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Gets the facts after they have been examined by the Rules Engine.
- getRootException() - Method in exception com.sap.brms.qrules.engine.NoSuchRuleException
-
Get the root exception.
- getRootException() - Method in exception com.sap.brms.qrules.engine.RuleException
-
Get the root exception.
- getRule(String) - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
This method returns the
AbstractRule
from this Ruleset.The Rule to be returned corresponds to the name of the
Rule given in the param
ruleName
.
- getRuleEngine() - Method in class com.sap.brms.qrules.engine.RuleEngineFactory
-
- getRuleNames() - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
This method returns the names of all the Rules that belong to this
Ruleset.
- getRuleset(String, String) - Method in interface com.sap.brms.qrules.ejb.local.RuleEngineLocal
-
- getRuleset(String, String) - Method in interface com.sap.brms.qrules.engine.RuleEngine
-
This method returns the Ruleset identified by the name in
rulesetName
param from the Project identified by the name in
projectName
param.
- getRulesetGuid(String) - Method in class com.sap.brms.qrules.engine.AbstractProject
-
This method returns the GUID of the Ruleset that corresponds to the name
given as the input parameter.
- getRulesetName() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Gets the name of the Ruleset that needs to be invoked.
- getRulesetNames() - Method in class com.sap.brms.qrules.engine.AbstractProject
-
This method retrieves the names of all the Rulesets in the Project.
- getRulesetUID() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Returns the GUID of the Ruleset to be invoked.
- getSchemaName() - Method in class com.sap.brms.qrules.xml.XMLObject
-
Returns the schema name if the schema name is explicitly set.
- getSchemasUsed() - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
This method returns names of all the schemas used in this Ruleset in the
form of a String array.
- getSDOXMLDocument() - Method in class com.sap.brms.qrules.xml.XMLObject
-
To get commonj.sdo.helper.XMLDocument for this XMLObject.
- getSystemDate() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Returns systemdate for the Ruleset represented by this RulesetContext.
- getType() - Method in class com.sap.brms.qrules.engine.AbstractDefinition
-
This method returns the return type of this Definition
- getType() - Method in class com.sap.brms.qrules.engine.AbstractRuleset
-
This method returns the type of this Ruleset.
- getValueOfRulesetFunctionResult() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Returns the value of of the Ruleset function result.
- getValueOfVariableDefinition(AbstractDefinition) - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Returns the value of the variable Definition after the invocation.
- getXmlAsByteArray() - Method in class com.sap.brms.qrules.xml.XMLObject
-
Returns the bytes of the underlying XML document.
- getXmlAsDocument() - Method in class com.sap.brms.qrules.xml.XMLObject
-
Returns a DOM representation of the underlying XML document.
- getXmlString() - Method in class com.sap.brms.qrules.xml.XMLObject
-
Get the String representation of the underlying XML document.
- guid - Variable in class com.sap.brms.qrules.engine.AbstractDefinition
-
String representation of GUID of this Definition
- guid - Variable in class com.sap.brms.qrules.engine.AbstractProject
-
Global unique identifier for the Project
- guid - Variable in class com.sap.brms.qrules.engine.AbstractRuleset
-
GUID of this Ruleset.
- id - Variable in class com.sap.brms.qrules.engine.RulesetContext
-
id for this context
- IEventDetails - Interface in com.sap.brms.qrules.engine
-
This interface is a holder for all the event details generated while invoking
a Ruleset.
- INITIAL_POOLSIZE - Static variable in class com.sap.brms.qrules.engine.RuleEngineFactory
-
The String initial poolsize that denotes the initial pool size capacity of the
Rule Engine.
- invokeRuleEntity(RulesetContext) - Method in interface com.sap.brms.qrules.engine.RuleEngine
-
Used to invoke rule entities such as a Decision Table directly.
- invokeRuleset(String, String, List) - Method in interface com.sap.brms.qrules.ejb.local.RuleEngineLocal
-
- invokeRuleset(RulesetContext) - Method in interface com.sap.brms.qrules.ejb.local.RuleEngineLocal
-
- invokeRuleset(RulesetContext) - Method in interface com.sap.brms.qrules.engine.RuleEngine
-
This is one of the main methods to invoke the Rules in a Ruleset.
- invokeRuleset(String, String, List) - Method in interface com.sap.brms.qrules.engine.RuleEngine
-
This is another method to invoke the Rules in a Ruleset.
- isActive() - Method in class com.sap.brms.qrules.engine.AbstractRule
-
This method will return the status of this Rule.
- isAssignable() - Method in class com.sap.brms.qrules.engine.AbstractDefinition
-
Returns true
if this Definition is assignable,
else returns false
- isCollectionOfAssignActionEventsAsStringEnabled() - Method in class com.sap.brms.qrules.engine.EventFilter
-
Returns true
if collection of detail for assign action
type has been enabled.
- isCollectionOfConditionFailedEventsAsStringEnabled() - Method in class com.sap.brms.qrules.engine.EventFilter
-
Returns true
if collection of detail for not satisfied
condition as String has been enabled.
- isCollectionOfConditionSatisfiedEventsAsStringEnabled() - Method in class com.sap.brms.qrules.engine.EventFilter
-
Returns true
if collection of detail for satisfied
condition as String has been enabled.
- isCollectionOfDecisionTableEventsAsStringEnabled() - Method in class com.sap.brms.qrules.engine.EventFilter
-
Returns true
if collection of detail for evaluate decision
table as String has been enabled.
- isCollectionOfEvaluateActionEventsAsStringEnabled() - Method in class com.sap.brms.qrules.engine.EventFilter
-
Returns true
if collection of detail for evaluate action
type has been enabled.
- isFlowRuleset() - Method in class com.sap.brms.qrules.engine.RulesetContext
-
Returns true if the ruleset represented by this context object is a flow
ruleset
- isPreconditionNegated(String) - Method in class com.sap.brms.qrules.engine.AbstractRule
-
Determines if the precondition to this Rule should be negated.
- isSharedResource - Variable in class com.sap.brms.qrules.engine.AbstractDefinition
-
boolean to know if this definition is part of shared resource
- isSharedResource() - Method in class com.sap.brms.qrules.engine.AbstractDefinition
-
Returns true
if this definition is part of shared
resources.
- reset() - Method in class com.sap.brms.qrules.engine.RuleEngineFactory
-
Resets the RuleEngine factory to configure it with different persistence and configuration.
- RETE - Static variable in interface com.sap.brms.qrules.ejb.local.RuleEngineLocal
-
An identifier to identify a bean of the type Rete
- RETE - Static variable in interface com.sap.brms.qrules.ejb.RuleEngineRemote
-
An identifier to identify a bean of the type Rete
- returnedFacts - Variable in class com.sap.brms.qrules.engine.RulesetContext
-
list to store returned Facts
- RuleEngine - Interface in com.sap.brms.qrules.engine
-
This is the main API for using the rule engine in its simplest form.
- RuleEngineFactory - Class in com.sap.brms.qrules.engine
-
- RuleEngineHome - Interface in com.sap.brms.qrules.ejb
-
The home interface of the RuleEngineBean
- RuleEngineLocal - Interface in com.sap.brms.qrules.ejb.local
-
Local interface for the RuleEngineBean.
- RuleEngineLocalHome - Interface in com.sap.brms.qrules.ejb.local
-
The local home interface of the RuleEngineBean
- RuleEngineRemote - Interface in com.sap.brms.qrules.ejb
-
Remote interface for the RuleEngineBean.
- RuleException - Exception in com.sap.brms.qrules.engine
-
An exception which signals an error while dealing with the Rules Engine.
- RuleException() - Constructor for exception com.sap.brms.qrules.engine.RuleException
-
default constructor
- RuleException(Exception) - Constructor for exception com.sap.brms.qrules.engine.RuleException
-
constructs RuleException object with specified root cause
- RuleException(String) - Constructor for exception com.sap.brms.qrules.engine.RuleException
-
constructs RuleException object with specified message
- RuleException(String, String) - Constructor for exception com.sap.brms.qrules.engine.RuleException
-
constructs RuleException object with specified message Id and a message
- RuleException(String, Exception) - Constructor for exception com.sap.brms.qrules.engine.RuleException
-
constructs a ruleException object with specified message and root cause
- RuleException(Exception, String, String) - Constructor for exception com.sap.brms.qrules.engine.RuleException
-
Creates a RuleException object with a specified message Id, message
and the root cause.
- RuleException(String, String, Exception) - Constructor for exception com.sap.brms.qrules.engine.RuleException
-
Creates a RuleException with the specified message and the location of
the message and the root cause.
- RuleException(String, String, String, Exception) - Constructor for exception com.sap.brms.qrules.engine.RuleException
-
Creates a RuleException with the specified message Id and message and
the location of the message and the root cause.
- ruleProperties - Variable in class com.sap.brms.qrules.engine.AbstractRule
-
User defined name, value pair properties
- RulesetContext - Class in com.sap.brms.qrules.engine
-
This class represents the context used to control the execution of Rules of a
Ruleset.
- RulesetContext() - Constructor for class com.sap.brms.qrules.engine.RulesetContext
-
Initializes a new instance of RulesetContext.
- RulesetContext.BusinessLogLevel - Enum in com.sap.brms.qrules.engine
-
- RulesetContext.EntityType - Enum in com.sap.brms.qrules.engine
-
Contains a list of entities which can be invoked from the Rule Engine.
- rulesetGUID - Variable in class com.sap.brms.qrules.engine.RulesetContext
-
- rulesetName - Variable in class com.sap.brms.qrules.engine.RulesetContext
-
Ruleset name
- rulesetNamesInUserOrder - Variable in class com.sap.brms.qrules.engine.AbstractProject
-
This list is required to store Rulesets name in the order prefered by user.
- rulesetNameVsComment - Variable in class com.sap.brms.qrules.engine.AbstractProject
-
This map stores Ruleset as key and comment as value
- rulesetNameVsGuid - Variable in class com.sap.brms.qrules.engine.AbstractProject
-
This map is intended to contain name of the Ruleset with its
corresponding GUIDs.
- rulesetNameVsType - Variable in class com.sap.brms.qrules.engine.AbstractProject
-
This map is intended to contain name of the Rulesets and corresponding type.
- rulesetProperties - Variable in class com.sap.brms.qrules.engine.AbstractRuleset
-
User defined properties for this Ruleset.