Rule Execution Server API

ilog.rules.engine
Class IlrRulesetParameter

java.lang.Object
  extended by ilog.rules.engine.IlrRulesetParameter
All Implemented Interfaces:
Serializable

public class IlrRulesetParameter
extends Object
implements Serializable

This class implements a ruleset parameter that is a tuple <type, name, modifier> which is in term of types a tuple <IlrType, String, int>.

See Also:
IlrType, Serialized Form

Method Summary
 IlrValue getDefaultValue()
          Deprecated. replaced by IlrVariable.getValue()
 int getKind()
          Returns the kind of the parameter.
 int getModifier()
          Returns the modifier of the parameter.
 String getName()
          Returns the name of the parameter.
 IlrType getType()
          Returns the type as IlrType of the parameter.
 void setDefaultValue(IlrValue value)
          Sets a default value to the parameter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getType

public IlrType getType()
Returns the type as IlrType of the parameter.

Returns:
the parameter type.

getName

public String getName()
Returns the name of the parameter.

Returns:
the parameter name.

getModifier

public int getModifier()
Returns the modifier of the parameter. The values are defined in the IlrRulesetConstants interface: 0 for a package variable IlrRulesetConstants.In for "in", IlrRulesetConstants.Out for "out", and IlrRulesetConstants.In | IlrRulesetConstants.Out for "inout".

Returns:
the parameter modifier.

getKind

public int getKind()
Returns the kind of the parameter. The values are defined in the IlrRulesetConstants interface: IlrRulesetConstants.Java for a "Java" parameter, IlrRulesetConstants.Xml for an "XML", parameter and IlrRulesetConstants.Ws for a "Web Service" parameter.

Returns:
the parameter modifier.

setDefaultValue

public void setDefaultValue(IlrValue value)
Sets a default value to the parameter.

Parameters:
value - The value set as the default value for the parameter.

getDefaultValue

public IlrValue getDefaultValue()
Deprecated. replaced by IlrVariable.getValue()

Returns the default value set for this parameter.

Returns:
The value set as the default value for the parameter.

Rule Execution Server API

© Copyright IBM Corp. 1987, 2013