com.sapportals.portal.appintegrator
Interface IParameterConveyor

public interface IParameterConveyor

Version:

$Revision: #1 $.

Method Summary

java.lang.Object	getParameter(java.lang.String id, int layerNo) Returns the value of the parameter inside the conveyor defined by its id for the given layerNo If the vat with the given layerNo is empty the slots above are searched until a non-null value is found.
java.util.Set	getParameterNames() Returns the over all set of parameter names that is available by the parameter conveyor
void	setLayerProperties(java.util.Map properties, int layerNo) Sets the properties for a given layer number
void	setParameter(java.lang.String id, java.lang.Object value) Sets the parameter defined by id and value for the top layer.
void	setParameter(java.lang.String id, java.lang.Object value, int layerNo) Sets the parameter defined by id and value for the given layer number.

Method Detail

setParameter

public void setParameter(java.lang.String id,
                         java.lang.Object value,
                         int layerNo)

Sets the parameter defined by id and value for the given layer number.

Parameters:

id - parameter id (name)

value - parameter value

layerNo - the layer number

setParameter

public void setParameter(java.lang.String id,
                         java.lang.Object value)

Sets the parameter defined by id and value for the top layer.

Parameters:

id - parameter id (name)

value - parameter value

getParameter

public java.lang.Object getParameter(java.lang.String id,
                                     int layerNo)

Returns the value of the parameter inside the conveyor defined by its id for the given layerNo If the vat with the given layerNo is empty the slots above are searched until a non-null value is found. If all slots are empty the POM-node is asked for the value.

Parameters:

id - parameter id (name)

layerNo - the layer number, if layerNo is greater or equal 0. If layerNo less than 0 the POM-node is looked up

Returns:

the value of the layerNoth slot of the vat with id=id. If no value could be found, the above layers are searched as far as the POM node itself is looked up.

getParameterNames

public java.util.Set getParameterNames()

Returns the over all set of parameter names that is available by the parameter conveyor

Returns:

set of all parameter names

setLayerProperties

public void setLayerProperties(java.util.Map properties,
                               int layerNo)

Sets the properties for a given layer number

Parameters:

properties - the layer properties

layerNo - the layer number