IlrParameterMap (Rule Designer API)

java.lang.Object
- ilog.rules.engine.IlrParameterMap

All Implemented Interfaces:

java.io.Serializable
```
public class IlrParameterMap
extends java.lang.Object
implements java.io.Serializable
```
Implements a structure for storing parameter values to set or get from ruleset variables. Each parameter is stored with its name and its value.

See Also:

IlrContext.setParameters(IlrParameterMap), IlrContext.getReturnValues(), IlrContext.execute(), IlrContext.execute(String name), IlrContext.executeTask(), Serialized Form

Constructor Summary

Constructors
Constructor and Description

IlrParameterMap()
Creates an empty IlrParameterMap.

Constructors
Constructor and Description
`IlrParameterMap()` Creates an empty `IlrParameterMap`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the internal structure.
`boolean`	`getBooleanValue(java.lang.String name)` Gets the boolean value of the parameter named "name".
`byte`	`getByteValue(java.lang.String name)` Gets the byte value of the parameter named "name".
`char`	`getCharValue(java.lang.String name)` Gets the char value of the parameter named "name".
`double`	`getDoubleValue(java.lang.String name)` Gets the double value of the parameter named "name".
`float`	`getFloatValue(java.lang.String name)` Gets the float value of the parameter named "name".
`int`	`getIntValue(java.lang.String name)` Gets the integer value of the parameter named "name".
`long`	`getLongValue(java.lang.String name)` Gets the long value of the parameter named "name".
`java.lang.Object`	`getObjectValue(java.lang.String name)` Gets the Object value of the parameter named "name".
`short`	`getShortValue(java.lang.String name)` Gets the short value of the parameter named "name".
`java.lang.String`	`getStringValue(java.lang.String name)` Gets the String value of the parameter named "name".
`java.util.Set`	`keySet()` Returns a java.util.Set with all the keys contained in the structure.
`void`	`setParameter(java.lang.String name, boolean value)` Store for the parameter "name" and its value "value".
`void`	`setParameter(java.lang.String name, byte value)` Store for the parameter "name" and its value "value".
`void`	`setParameter(java.lang.String name, char value)` Store for the parameter "name" and its value "value".
`void`	`setParameter(java.lang.String name, double value)` Store for the parameter "name" and its value "value".
`void`	`setParameter(java.lang.String name, float value)` Store for the parameter "name" and its value "value".
`void`	`setParameter(java.lang.String name, int value)` Store for the parameter "name" and its value "value".
`void`	`setParameter(java.lang.String name, long value)` Store for the parameter "name" and its value "value".
`void`	`setParameter(java.lang.String name, java.lang.Object value)` Store for the parameter "name" and its value "value".
`void`	`setParameter(java.lang.String name, short value)` Store for the parameter "name" and its value "value".
`void`	`setParameter(java.lang.String name, java.lang.String value)` Store for the parameter "name" and its value "value".
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IlrParameterMap
```
public IlrParameterMap()
```
    Creates an empty IlrParameterMap.
- Method Detail
  - keySet
```
public java.util.Set keySet()
```
    Returns a java.util.Set with all the keys contained in the structure.
    
    Returns:
    
    The keys stored in the structure.
  - setParameter
```
public void setParameter(java.lang.String name,
                         boolean value)
```
    Store for the parameter "name" and its value "value".
    
    Parameters:
    
    name - The parameter name.
    
    value - The value of the boolean parameter.
  - setParameter
```
public void setParameter(java.lang.String name,
                         byte value)
```
    Store for the parameter "name" and its value "value".
    
    Parameters:
    
    name - The parameter name.
    
    value - The value of the byte parameter.
  - setParameter
```
public void setParameter(java.lang.String name,
                         char value)
```
    Store for the parameter "name" and its value "value".
    
    Parameters:
    
    name - The parameter name.
    
    value - The value of the char parameter.
  - setParameter
```
public void setParameter(java.lang.String name,
                         int value)
```
    Store for the parameter "name" and its value "value".
    
    Parameters:
    
    name - The parameter name.
    
    value - The value of the integer parameter.
  - setParameter
```
public void setParameter(java.lang.String name,
                         float value)
```
    Store for the parameter "name" and its value "value".
    
    Parameters:
    
    name - The parameter name.
    
    value - The value of the float parameter.
  - setParameter
```
public void setParameter(java.lang.String name,
                         double value)
```
    Store for the parameter "name" and its value "value".
    
    Parameters:
    
    name - The parameter name.
    
    value - The value of the double parameter.
  - setParameter
```
public void setParameter(java.lang.String name,
                         short value)
```
    Store for the parameter "name" and its value "value".
    
    Parameters:
    
    name - The parameter name.
    
    value - The value of the short parameter.
  - setParameter
```
public void setParameter(java.lang.String name,
                         long value)
```
    Store for the parameter "name" and its value "value".
    
    Parameters:
    
    name - The parameter name.
    
    value - The value of the long parameter.
  - setParameter
```
public void setParameter(java.lang.String name,
                         java.lang.Object value)
```
    Store for the parameter "name" and its value "value".
    
    Parameters:
    
    name - The parameter name.
    
    value - The value of the Object parameter.
  - setParameter
```
public void setParameter(java.lang.String name,
                         java.lang.String value)
```
    Store for the parameter "name" and its value "value".
    
    Parameters:
    
    name - The parameter name.
    
    value - The value of the String parameter.
  - getBooleanValue
```
public boolean getBooleanValue(java.lang.String name)
```
    Gets the boolean value of the parameter named "name". If the parameter is unknown, an IllegalArgumentException is thrown. If the parameter value is not a boolean, a ClassCastException is thrown.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The boolean value of the parameter.
  - getByteValue
```
public byte getByteValue(java.lang.String name)
```
    Gets the byte value of the parameter named "name". If the parameter is unknown, an IllegalArgumentException is thrown. If the parameter value is not a byte, a ClassCastException is thrown.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The byte value of the parameter.
  - getCharValue
```
public char getCharValue(java.lang.String name)
```
    Gets the char value of the parameter named "name". If the parameter is unknown, an IllegalArgumentException is thrown. If the parameter value is not a char, a ClassCastException is thrown.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The char value of the parameter.
  - getIntValue
```
public int getIntValue(java.lang.String name)
```
    Gets the integer value of the parameter named "name". If the parameter is unknown, an IllegalArgumentException is thrown. If the parameter value is not an integer, a ClassCastException is thrown.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The integer value of the parameter.
  - getFloatValue
```
public float getFloatValue(java.lang.String name)
```
    Gets the float value of the parameter named "name". If the parameter is unknown, an IllegalArgumentException is thrown. If the parameter value is not a float, a ClassCastException is thrown.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The float value of the parameter.
  - getDoubleValue
```
public double getDoubleValue(java.lang.String name)
```
    Gets the double value of the parameter named "name". If the parameter is unknown, an IllegalArgumentException is thrown. If the parameter value is not a double, a ClassCastException is thrown.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The double value of the parameter.
  - getShortValue
```
public short getShortValue(java.lang.String name)
```
    Gets the short value of the parameter named "name". If the parameter is unknown, an IllegalArgumentException is thrown. If the parameter value is not a short, a ClassCastException is thrown.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The short value of the parameter.
  - getLongValue
```
public long getLongValue(java.lang.String name)
```
    Gets the long value of the parameter named "name". If the parameter is unknown, an IllegalArgumentException is thrown. If the parameter value is not a long, a ClassCastException is thrown.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The long value of the parameter.
  - getObjectValue
```
public java.lang.Object getObjectValue(java.lang.String name)
```
    Gets the Object value of the parameter named "name". If the parameter is unknown, an IllegalArgumentException is thrown.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The Object value of the parameter.
  - getStringValue
```
public java.lang.String getStringValue(java.lang.String name)
```
    Gets the String value of the parameter named "name". If the parameter is unknown, an IllegalArgumentException is thrown. If the parameter value is not an String, a ClassCastException is thrown.
    
    Parameters:
    
    name - The parameter name.
    
    Returns:
    
    The String value of the parameter.
  - clear
```
public void clear()
```
    Clears the internal structure.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Methods inherited from class java.lang.Object

IlrParameterMap

keySet

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

getBooleanValue

getByteValue

getCharValue

getIntValue

getFloatValue

getDoubleValue

getShortValue

getLongValue

getObjectValue

getStringValue

clear

toString