RuleService (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

All Known Implementing Classes:

DefaultRuleService
```
public interface RuleService
```
The interface provides with method for fetching all rules available.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AbstractRuleModel`	`cloneRule(AbstractRuleModel source)` Clones given rule.
`<T extends AbstractRuleModel> T`	`createRuleFromTemplate(AbstractRuleTemplateModel ruleTemplate)` Creates new rule from given rule template.
`SourceRuleModel`	`createRuleFromTemplate(SourceRuleTemplateModel ruleTemplate)` Deprecated. since 6.1, use the `createRuleFromTemplate(AbstractRuleTemplateModel)` method
`List<AbstractRuleModel>`	`getAllActiveRules()` Gets all active `AbstractRuleModel`s
`List<AbstractRuleModel>`	`getAllActiveRulesForType(Class ruleType)` Gets all active `AbstractRuleModel`s by a specific type
`List<AbstractRuleModel>`	`getAllRules()` Gets all `AbstractRuleModel`s
`List<AbstractRuleModel>`	`getAllRulesForType(Class ruleType)` Gets all `AbstractRuleModel`s by a specific type
`List<AbstractRuleModel>`	`getAllToBePublishedRules()` Gets all rules to be published `AbstractRuleModel`s
`List<AbstractRuleModel>`	`getAllToBePublishedRulesForType(Class ruleType)` Gets all rules to be published `AbstractRuleModel`s by a specific type
`RuleType`	`getEngineRuleTypeForRuleType(Class<?> type)` Finds engine rule type for given rule type.
`AbstractRuleModel`	`getRuleByCode(String code)` Deprecated. since 6.1, use the `getRuleForCode(String)`
`AbstractRuleModel`	`getRuleForCode(String code)` Gets `AbstractRuleModel` by code.
`Class<? extends AbstractRuleModel>`	`getRuleTypeFromTemplate(Class<? extends AbstractRuleTemplateModel> templateType)` Finds and returns rule type model class based on the template type

- Method Detail
  - getAllRules
```
List<AbstractRuleModel> getAllRules()
```
    Gets all AbstractRuleModels
    
    Returns:
    
    List of AbstractRuleModels
  - getAllRulesForType
```
List<AbstractRuleModel> getAllRulesForType(Class ruleType)
```
    Gets all AbstractRuleModels by a specific type
    
    Parameters:
    
    ruleType -
    
    Returns:
    
    List of AbstractRuleModels
  - getAllActiveRules
```
List<AbstractRuleModel> getAllActiveRules()
```
    Gets all active AbstractRuleModels
    
    Returns:
    
    List of AbstractRuleModels
  - getAllActiveRulesForType
```
List<AbstractRuleModel> getAllActiveRulesForType(Class ruleType)
```
    Gets all active AbstractRuleModels by a specific type
    
    Parameters:
    
    ruleType -
    
    Returns:
    
    List of AbstractRuleModels
  - getAllToBePublishedRules
```
List<AbstractRuleModel> getAllToBePublishedRules()
```
    Gets all rules to be published AbstractRuleModels
    
    Returns:
    
    List of AbstractRuleModels
  - getAllToBePublishedRulesForType
```
List<AbstractRuleModel> getAllToBePublishedRulesForType(Class ruleType)
```
    Gets all rules to be published AbstractRuleModels by a specific type
    
    Parameters:
    
    ruleType -
    
    Returns:
    
    List of AbstractRuleModels
  - getRuleByCode
```
@Deprecated
AbstractRuleModel getRuleByCode(String code)
```
    Deprecated. since 6.1, use the getRuleForCode(String)
    
    Gets AbstractRuleModel by code.
    
    Parameters:
    
    code -
    
    Returns:
    
    AbstractRuleModel
  - getRuleForCode
```
AbstractRuleModel getRuleForCode(String code)
```
    Gets AbstractRuleModel by code.
    
    Parameters:
    
    code -
    
    Returns:
    
    AbstractRuleModel
  - createRuleFromTemplate
```
@Deprecated
SourceRuleModel createRuleFromTemplate(SourceRuleTemplateModel ruleTemplate)
```
    Deprecated. since 6.1, use the createRuleFromTemplate(AbstractRuleTemplateModel) method
    
    Creates new rule from given rule template.
    
    Parameters:
    
    ruleTemplate - - rule template to clone to new rule
    
    Returns:
    
    null if given ruleTemplate is null or not a template. Otherwise, new rule, which is a copy of the given template.
  - createRuleFromTemplate
```
<T extends AbstractRuleModel> T createRuleFromTemplate(AbstractRuleTemplateModel ruleTemplate)
```
    Creates new rule from given rule template.
    
    Parameters:
    
    ruleTemplate - - rule template to clone to new rule
    
    Returns:
    
    the new rule, which is a copy of the given template.
  - cloneRule
```
AbstractRuleModel cloneRule(AbstractRuleModel source)
```
    Clones given rule.
    
    Parameters:
    
    source - - rule to clone
    
    Returns:
    
    target - cloned rule
  - getRuleTypeFromTemplate
```
Class<? extends AbstractRuleModel> getRuleTypeFromTemplate(Class<? extends AbstractRuleTemplateModel> templateType)
```
    Finds and returns rule type model class based on the template type
    
    Parameters:
    
    templateType - - template type
    
    Returns:
    
    rule type model
  - getEngineRuleTypeForRuleType
```
RuleType getEngineRuleTypeForRuleType(Class<?> type)
```
    Finds engine rule type for given rule type. If no mapping is found it returns RuleType.DEFAULT.
    
    Parameters:
    
    type - - type of the rule.
    
    Returns:
    
    RuleType of the engine rule

Interface RuleService

Method Summary

Method Detail

getAllRules

getAllRulesForType

getAllActiveRules

getAllActiveRulesForType

getAllToBePublishedRules

getAllToBePublishedRulesForType

getRuleByCode

getRuleForCode

createRuleFromTemplate

createRuleFromTemplate

cloneRule

getRuleTypeFromTemplate

getEngineRuleTypeForRuleType