Rule Execution Server API

ilog.rules.studio.res.generator.impl
Class IlrPOJOGenerator.PojoRulesetArchive

java.lang.Object
  extended by ilog.rules.studio.res.generator.IlrFileGenerator.RulesetArchive
      extended by ilog.rules.studio.res.generator.impl.IlrPOJOGenerator.PojoRulesetArchive
Enclosing class:
IlrPOJOGenerator

public class IlrPOJOGenerator.PojoRulesetArchive
extends IlrFileGenerator.RulesetArchive

Stores a ruleset archive name and version with two lists of parameters:


Method Summary
 String getCallSignature()
          Gets the ruleset signature to call the method.
 List getOutParameter(String var)
          Deprecated. As of JRules 7.0, replaced by getOutParameterAsString(String var).
 List<String> getOutParameterAsString(String var)
          Gets the helper method to store the out ruleset parameters in the result class.
 List getOutParameterWithHelperMethod(String var)
          Deprecated. As of JRules 7.0, replaced by getOutParameterWithHelperMethodAsString(String var).
 List<String> getOutParameterWithHelperMethodAsString(String var)
          Gets the helper method to store the out ruleset parameters in the result class.
 String getRulesetResultClassName()
          Gets the ruleset class name.
 String getRulesetResultClassNameWithVersion()
          Gets the ruleset class name.
 String getTaskName()
          Gets the main task name if the ruleset archive contains a ruleflow.
 boolean isVersionMandatory()
          Returns code>true if the version is mandatory to avoid duplication in the generated names.
 
Methods inherited from class ilog.rules.studio.res.generator.IlrFileGenerator.RulesetArchive
getInParameters, getInParameterSignatures, getMethodSignature, getOutParameters, getOutParameterSignatures, getRulesetClassName, getRulesetClassNameWithVersion, getRulesetDisplayName, getRulesetName, getRulesetNameWithVersion, getRulesetVersion
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getRulesetResultClassNameWithVersion

public String getRulesetResultClassNameWithVersion()
Gets the ruleset class name. The first letter is a major letter and the name is suffixed with 'Result'.

Returns:
The result ruleset class name to generate.

getRulesetResultClassName

public String getRulesetResultClassName()
Gets the ruleset class name. The first letter is a major letter and the name is suffixed with 'Result'.

Returns:
The result ruleset class name to generate.

getOutParameterWithHelperMethod

public List getOutParameterWithHelperMethod(String var)
Deprecated. As of JRules 7.0, replaced by getOutParameterWithHelperMethodAsString(String var).

Gets the helper method to store the out ruleset parameters in the result class.

Parameters:
var - The name of the IlrRulesetExecutionResponse object.
Returns:
The list of the helper methods to get the out ruleset parameters.

getOutParameterWithHelperMethodAsString

public List<String> getOutParameterWithHelperMethodAsString(String var)
Gets the helper method to store the out ruleset parameters in the result class.

Since:
JRules 7.0
Parameters:
var - The name of the IlrRulesetExecutionResponse object.
Returns:
The list of the helper methods to get the Out ruleset parameters.

getOutParameter

public List getOutParameter(String var)
Deprecated. As of JRules 7.0, replaced by getOutParameterAsString(String var).

Gets the helper method to store the out ruleset parameters in the result class.

Parameters:
var - The name of the IlrSessionResponse object.
Returns:
The list of the helper methods to get the out ruleset parameters.

getOutParameterAsString

public List<String> getOutParameterAsString(String var)
Gets the helper method to store the out ruleset parameters in the result class.

Since:
JRules 7.0
Parameters:
var - The name of the IlrSessionResponse object.
Returns:
The list of the helper methods to get the Out ruleset parameters.

getTaskName

public String getTaskName()
Gets the main task name if the ruleset archive contains a ruleflow. If the ruleset archive does not contain a ruleflow, null is returned.

Returns:
The main task name if the ruleset contains a ruleflow, null otherwise.

isVersionMandatory

public boolean isVersionMandatory()
Returns code>true if the version is mandatory to avoid duplication in the generated names. Otherwise returns code>false. A duplication can be generated if the RuleApp contains two rulesets with the same name but with two different versions.

Returns:
code>true if the version is mandatory, otherwise returns code>false.

getCallSignature

public String getCallSignature()
Gets the ruleset signature to call the method.

Overrides:
getCallSignature in class IlrFileGenerator.RulesetArchive
Returns:
The ruleset call signature.

Rule Execution Server API

© Copyright IBM Corp. 1987, 2013