ilog.rules.ras.core.execution.impl
Class IlrBaseInOutParameters

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap
          ilog.rules.ras.core.execution.impl.IlrBaseInOutParameters

All Implemented Interfaces:

IlrInOutParameters, IlrInputParameters, IlrOutputParameters, Serializable, Cloneable, Map

Direct Known Subclasses:

IlrOrderedInOutParameters

public class IlrBaseInOutParameters
extends HashMap
implements IlrInOutParameters

Default implementation of the ilog.rules.ras.core.IlrInOutParameters interface.

See Also:

Serialized Form

Constructor Summary

IlrBaseInOutParameters()
Default constructor.

IlrBaseInOutParameters(Map inputParams)
A constructor.

Method Summary

String	getDescription() Gets the description of the in/out parameters.
int	getInOut() Gets the type of the parameters list.
String	getName() Gets the name of the in/out parameters.
String	getType() Gets the type of these input parameters.
void	setDescription(String description) Sets the description of the parameters.
void	setInOut(int inOut) Sets the InOut type of the parameters list.
void	setName(String name) Sets the name of the in/out parameters.
void	setType(String type) Sets the XML type of the parameters list.
Map	toMap() Gets the backing map.

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ilog.rules.ras.core.IlrInputParameters

put

Methods inherited from interface ilog.rules.ras.core.IlrOutputParameters

put

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

IlrBaseInOutParameters

public IlrBaseInOutParameters()

Default constructor.

IlrBaseInOutParameters

public IlrBaseInOutParameters(Map inputParams)

A constructor.

Parameters:

inputParams - The wrapped input parameters.

Method Detail

toMap

public Map toMap()

Description copied from interface: IlrInputParameters

Gets the backing map.

Specified by:

toMap in interface IlrInputParameters

Specified by:

toMap in interface IlrOutputParameters

Returns:

The map used to hold the input parameters.

getName

public String getName()

Gets the name of the in/out parameters.

Specified by:

getName in interface IlrInputParameters

Specified by:

getName in interface IlrOutputParameters

Returns:

The name of the parameters.

setName

public void setName(String name)

Sets the name of the in/out parameters.

Parameters:

name - The name to set.

getDescription

public String getDescription()

Gets the description of the in/out parameters.

Specified by:

getDescription in interface IlrInputParameters

Specified by:

getDescription in interface IlrOutputParameters

Returns:

The description of the parameters.

setDescription

public void setDescription(String description)

Sets the description of the parameters.

Parameters:

description - The description to set.

getType

public String getType()

Description copied from interface: IlrInputParameters

Gets the type of these input parameters.

Specified by:

getType in interface IlrInputParameters

Specified by:

getType in interface IlrOutputParameters

Returns:

The type of these input parameters.

setType

public void setType(String type)

Sets the XML type of the parameters list. The possible values are:

• IlrConstant.TYPE_BOMXML: For a BOM serialization
• IlrConstant.TYPE_DYNXML: For dynamic binding
• IlrConstant.TYPE_RSMXML: For the standard RSM XML serialization.

Parameters:

type - The type to be set.

setInOut

public void setInOut(int inOut)

Sets the InOut type of the parameters list. The possible values are:

• IlrConstant.INOUT_INPUT: For input direction
• IlrConstant.INOUT_OUTPUT: For output direction
• IlrConstant.INOUT_BOTH: Not in use today.

Parameters:

inOut - The inOut type to be set.

getInOut

public int getInOut()

Description copied from interface: IlrInOutParameters

Gets the type of the parameters list.

Specified by:

getInOut in interface IlrInOutParameters

Returns:

One of three possible values: 1 for input parameters, 2 for output parameters, 3 for in/out parameters.