Package com.aquima.interactions.rule

Interface IRuleGraph

All Known Implementing Classes:
InferenceEngine, RuleGraph
public interface IRuleGraph
Interface for the object structure containing all the business rules.
Since:
5.0
Author:
O. Kerpershoek

  • Method Details

    • getRuleGroup

      IRuleGroup getRuleGroup(String name)
      This method returns the rule group definition for the specified name.
      Parameters:
      name - The name of the requested rule group.
      Returns:
      The rule group definition for the specified name.
      Throws:
      UnknownRuleGroupException - This exception is thrown when no rule group is defined with the specified name.

    • getAllEntityNodes

      IEntityNode[] getAllEntityNodes()
      This method returns an array containing all the entity nodes present in the rule graph.
      Returns:
      Array containing all the entity nodes of the rule graph.

    • getEntityNode

      IEntityNode getEntityNode(String entity)
      This method returns the IEntityNode of the dependency graph for the given entity name.
      Parameters:
      entity - The name of the entity.
      Returns:
      IEntityNode The entity node of the dependency graph for the given entity name.
      Throws:
      UnknownEntityException - This exception will be thrown when the provided entity does not exist in the metamodel.

    • getAttributeNode

      IAttributeNode getAttributeNode(String entity, String attribute)
      This method returns the IAttributeNodeof the dependency graph for the given attribute. When the attribute is not used by a business rule, this method may return null.
      Parameters:
      entity - The name of the entity that contains the attribute (this does not need to be the name of the entity in which the attribute is defined, but may also be the entity that contains the attribute by inheritance.
      attribute - The name of the attribute.
      Returns:
      IAttributeNode The attribute node of the dependency graph for the given attribute name, or null when the attribute has no dependencies.
      Throws:
      UnknownEntityException - This exception will be thrown when the provided entity does not exist in the metamodel.
      UnknownAttributeException - This exception will be thrown when the provided attribute does not exist in the provided entity.