Rule Execution Server API

com.ibm.rules.engine.runtime
Interface EngineData


public interface EngineData

An EngineData stores the values used as the parameters of an engine.

The EngineData has methods to retrieve the parameter values. The values can be set or reset when an EngineData is used inside an EngineInput.

See Also:
EngineInput, EngineOutput

Method Summary
 Object get(String name)
          Returns the value of a specific parameter.
 Map<String,Object> getAll()
          Returns the values of all the parameters.
 Map<String,Object> getIn()
          Returns the values of all the parameters that are declared as in parameters.
 Map<String,Object> getOut()
          Returns the values of all the parameters that are declared as out parameters.
 EngineSignature getSignature()
          Returns the signature that corresponds to this EngineData instance.
 

Method Detail

getSignature

EngineSignature getSignature()
Returns the signature that corresponds to this EngineData instance.

Returns:
The signature that corresponds to this EngineData instance.

get

Object get(String name)
Returns the value of a specific parameter.

Throws:
IllegalArgumentException - if there is no parameter with the given name
Parameters:
name - The key of the parameter to be returned.
Returns:
The value of the parameter.

getAll

Map<String,Object> getAll()
Returns the values of all the parameters.

Returns:
The values of all the parameters. If there are no parameters, an empty Map is returned.
See Also:
EngineSignature.getAllParameters()

getIn

Map<String,Object> getIn()
Returns the values of all the parameters that are declared as in parameters.

Returns:
The values of all the parameters that are declared as in parameters.
See Also:
EngineSignature.getInParameters()

getOut

Map<String,Object> getOut()
Returns the values of all the parameters that are declared as out parameters.

Returns:
The values of all the parameters that are declared as out parameters.
See Also:
EngineSignature.getOutParameters()

Rule Execution Server API

© Copyright IBM Corp. 1987, 2013