out

The out keyword defines a ruleset output parameter.

Purpose

This keyword is used in a ruleset declaration to define a ruleset output parameter to exchange data between the application and the ruleset.

Context

At the top level of rulesets

Syntax

ruleset rulesetName
 {
   [in typeName variableName;] 
   [inout typeName variableName;] 
   [out typeName variableName [= value];] 
  };

Description

Ruleset parameters are accessible from a rule, a function, or a task definition in the ruleset.

Rulesets support three types of parameters: in, inout, and out.

You cannot specify an initial value in the ruleset for the in and inout parameters because they are initialized by the EngineInput#setParameters(java.util.Map) method. However, you can initialize the out parameter.

The out ruleset variables can be initialized in the ruleset.

You access the in, inout, and out parameters through the EngineInput and EngineOutput objects that are created when you execute your ruleset. Use the EngineInput#setParameters(java.util.Map) method to initialize the in and inout parameters.