Package ch.ivyteam.ivy.rule.engine.api

Class Rules

java.lang.Object
ch.ivyteam.ivy.rule.engine.api.Rules
@Deprecated(since="12.0.12", forRemoval=true) public final class Rules extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
This class provides the Java API to access all the features of the Rule engine. It is the equivalent for the rules environment variable in IvyScript. Example: 
 ivy.rules.create()
 .namespace("namespace.of.rules")
 .executor()
 .execute(data);
API:
This is a public API.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final IRuleEngine
    engine
    Deprecated.
    use create()

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    clearCache()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Clears the internal rule executor cache.
    static IRuleExecutorBuilder
    create()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new IRuleExecutorBuilder for building an IRuleExecutor to execute rules on data objects.
    static IRuleEngine
    engine()
    Deprecated.
    use create()

  • Field Details

  • Method Details

    • engine

      @Deprecated(since="9.2") public static IRuleEngine engine()
      Deprecated.
      use create()
      Provides access to the IRuleEngine.
      Returns:
      the IRuleEngine
      API:
      This public API is available in Java.

    • create

      public static IRuleExecutorBuilder create()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new IRuleExecutorBuilder for building an IRuleExecutor to execute rules on data objects.

      Example: 

       ivy.rules.create()
 .namespace("namespace.of.rules")
 .executor()
 .execute(data);
      Returns:
      IRuleExecutorBuilder
      Since:
      9.2
      API:
      This public API is available in Java.

    • clearCache

      public static void clearCache()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Clears the internal rule executor cache. Normally the cache does not need to be invalidated manually. It is automatically invalidated, for example when new rules are deployed.
      Since:
      9.2
      API:
      This public API is available in Java.