Package org.frankframework.parameters

Interface IParameter

All Superinterfaces:

org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.Aware, FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, NameAware

All Known Implementing Classes:

AbstractParameter, BooleanParameter, DateParameter, JsonParameter, NumberParameter, Parameter, XmlParameter

@FrankDocGroup(PARAMETER)
public interface IParameter
extends IConfigurable, FrankElement, NameAware

Method Summary

Modifier and Type	Method	Description
boolean	consumesSessionVariable(String sessionKey)
AbstractParameter.ParameterMode	getMode()
String	getSessionKey()
ParameterType	getType()
String	getValue()
Object	getValue(ParameterValueList alreadyResolvedParameters, Message message, PipeLineSession session, boolean namespaceAware)	Internal method.
ParameterValue	getValue(Message message, PipeLineSession session)	The value of the parameter, not namespace aware.
boolean	isHidden()
boolean	requiresInputValueForResolution()
void	setPattern(String string)
void	setSessionKey(String sessionKey)	Key of a PipelineSession-variable.
void	setValue(String value)	The value of the parameter, or the base for transformation using xpathExpression or stylesheet, or formatting.

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.IConfigurable

configure

Methods inherited from interface org.frankframework.core.NameAware

setName

Method Details

getType

ParameterType getType()

getMode

AbstractParameter.ParameterMode getMode()

requiresInputValueForResolution

boolean requiresInputValueForResolution()

consumesSessionVariable

boolean consumesSessionVariable(String sessionKey)

setSessionKey

void setSessionKey(String sessionKey)

Key of a PipelineSession-variable.
If specified, the value of the PipelineSession variable is used as input for the xpathExpression or stylesheet, instead of the current input message.
If no xpathExpression or stylesheet are specified, the value itself is returned.
If the value '*' is specified, all existing sessionkeys are added as parameter of which the name starts with the name of this parameter.
If also the name of the parameter has the value '*' then all existing sessionkeys are added as parameter (except tsReceived)

setPattern

void setPattern(String string)

getSessionKey

String getSessionKey()

setValue

void setValue(String value)

The value of the parameter, or the base for transformation using xpathExpression or stylesheet, or formatting.

getValue

String getValue()

getValue

ParameterValue getValue(Message message,
 PipeLineSession session)
                 throws ParameterException

The value of the parameter, not namespace aware.

Throws:

ParameterException

getValue

Object getValue(ParameterValueList alreadyResolvedParameters,
 Message message,
 PipeLineSession session,
 boolean namespaceAware)
         throws ParameterException

Internal method. Should not be called directly.

Throws:

ParameterException

isHidden

boolean isHidden()