RuleCompilerContext (hybris Commerce Suite 18.11)

All Known Implementing Classes:

DefaultRuleCompilerContext
```
public interface RuleCompilerContext
```
This interface represents the context valid for the compilation of a rule. It is passed to, and potentially modified by, each phase of the compilation process.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addProblem(RuleCompilerProblem problem)` Adds a problem arose during compilation process to the list.
`RuleIrLocalVariablesContainer`	`createLocalContainer()` A shortcut to `RuleIrVariablesGenerator.createLocalContainer()`.
`java.lang.String`	`generateLocalVariable(RuleIrLocalVariablesContainer container, java.lang.Class<?> type)` A shortcut to `RuleIrVariablesGenerator.generateLocalVariable(RuleIrLocalVariablesContainer, Class)`.
`java.lang.String`	`generateVariable(java.lang.Class<?> type)` A shortcut to `RuleIrVariablesGenerator.generateVariable(Class)`.
`java.util.Map<java.lang.String,RuleActionDefinitionData>`	`getActionDefinitions()` Returns action definitions for rule
`java.util.Map<java.lang.String,java.lang.Object>`	`getAttributes()` Returns a mutable `Map` that can be used to store attributes associated with this `RuleCompilerContext`.
`java.util.Map<java.lang.String,RuleConditionDefinitionData>`	`getConditionDefinitions()` Returns condition definitions for rule
`java.util.List<java.lang.Exception>`	`getFailureExceptions()` Returns all failure causing exceptions for this `RuleCompilerContext`.
`java.lang.String`	`getModuleName()` Returns the rules module name.
`java.util.List<RuleCompilerProblem>`	`getProblems()` Returns all problems arose during compilation process.
`AbstractRuleModel`	`getRule()` Returns the rule.
`RuleCompilationContext`	`getRuleCompilationContext()` get Rules compilation context for a given compilation
`java.util.List<RuleConditionData>`	`getRuleConditions()` Returns rule conditions for rule
`java.util.List<RuleParameterData>`	`getRuleParameters()` Returns the rule parameters.
`long`	`getRuleVersion()` Returns the rule version.
`RuleIrVariablesGenerator`	`getVariablesGenerator()` Returns the variables generator valid for this compiler context.
`void`	`setRuleVersion(long version)` Provides means of setting engine version of the rule.

- Method Detail
  - getRule
```
AbstractRuleModel getRule()
```
    Returns the rule.
    
    Returns:
    
    rule
  - getRuleVersion
```
long getRuleVersion()
```
    Returns the rule version.
    
    Returns:
    
    engine rule version
  - setRuleVersion
```
void setRuleVersion(long version)
```
    Provides means of setting engine version of the rule.
    
    Parameters:
    
    version - - engine rule version
  - getModuleName
```
java.lang.String getModuleName()
```
    Returns the rules module name.
    
    Returns:
    
    rules module name
  - getRuleParameters
```
java.util.List<RuleParameterData> getRuleParameters()
```
    Returns the rule parameters.
    
    Returns:
    
    The rule parameters
  - getVariablesGenerator
```
RuleIrVariablesGenerator getVariablesGenerator()
```
    Returns the variables generator valid for this compiler context.
    
    Returns:
    
    the variables generator
  - generateVariable
```
java.lang.String generateVariable(java.lang.Class<?> type)
```
    A shortcut to RuleIrVariablesGenerator.generateVariable(Class).
    
    Parameters:
    
    type - - the type
    
    Returns:
    
    the name of the variable
  - createLocalContainer
```
RuleIrLocalVariablesContainer createLocalContainer()
```
    A shortcut to RuleIrVariablesGenerator.createLocalContainer().
    
    Returns:
    
    the current container
  - generateLocalVariable
```
java.lang.String generateLocalVariable(RuleIrLocalVariablesContainer container,
                                       java.lang.Class<?> type)
```
    A shortcut to RuleIrVariablesGenerator.generateLocalVariable(RuleIrLocalVariablesContainer, Class).
    
    Parameters:
    
    type - - the type
    
    Returns:
    
    the name of the variable
  - getAttributes
```
java.util.Map<java.lang.String,java.lang.Object> getAttributes()
```
    Returns a mutable Map that can be used to store attributes associated with this RuleCompilerContext.
    
    Returns:
    
    the map containing the attributes
  - getFailureExceptions
```
java.util.List<java.lang.Exception> getFailureExceptions()
```
    Returns all failure causing exceptions for this RuleCompilerContext.
  - getProblems
```
java.util.List<RuleCompilerProblem> getProblems()
```
    Returns all problems arose during compilation process.
  - addProblem
```
void addProblem(RuleCompilerProblem problem)
```
    Adds a problem arose during compilation process to the list.
    
    Parameters:
    
    problem -
  - getConditionDefinitions
```
java.util.Map<java.lang.String,RuleConditionDefinitionData> getConditionDefinitions()
```
    Returns condition definitions for rule
  - getActionDefinitions
```
java.util.Map<java.lang.String,RuleActionDefinitionData> getActionDefinitions()
```
    Returns action definitions for rule
  - getRuleConditions
```
java.util.List<RuleConditionData> getRuleConditions()
```
    Returns rule conditions for rule
  - getRuleCompilationContext
```
RuleCompilationContext getRuleCompilationContext()
```
    get Rules compilation context for a given compilation
    
    Returns:
    
    instance of RuleCompilationContext

Interface RuleCompilerContext

Method Summary

Method Detail

getRule

getRuleVersion

setRuleVersion

getModuleName

getRuleParameters

getVariablesGenerator

generateVariable

createLocalContainer

generateLocalVariable

getAttributes

getFailureExceptions

getProblems

addProblem

getConditionDefinitions

getActionDefinitions

getRuleConditions

getRuleCompilationContext