Package de.xima.fc.workflow.parser.infix

Interface IValidationOptions

All Known Implementing Classes:

ValidationOptions

public interface IValidationOptions

Options that are passed to IInfixExpressionHandler.validate(CharSequence, IValidationOptions) to configure that method's behavior.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
Set<String>	getKnownVariables()
Locale	getLocale()
Function<String,Boolean>	getVariableExistenceCheck()
boolean	isTreatExtraneousVariablesAsError()
boolean	isTreatNonExistingVariablesAsError()

Method Detail

getKnownVariables

Set<String> getKnownVariables()

Returns:

All variables that are definitely known to exist. For dynamic variables you may also use getVariableExistenceCheck(). Note that this is overridden by the result of getVariableExistenceCheck() when that return a non-null value.

getLocale

Locale getLocale()

Returns:

Optional locale for localizing error messages. Locale.ENGLISH is used when this returns null.

getVariableExistenceCheck

Function<String,Boolean> getVariableExistenceCheck()

Returns:

A test that, given the name of a variable, checks whether that variable exists. This can be used for dynamic variables. When this returns null, the result of getKnownVariables() is used instead. When not null, the result of this check overrides the result of getKnownVariables(). Must return true when the variable exists, false when the variable does not exist, and null when not certain whether it exists.

isTreatExtraneousVariablesAsError

boolean isTreatExtraneousVariablesAsError()

Returns:

true to create messages with severity FCMessage.ESeverity.ERROR when a variable is found that does not occur in the expression, or false to create messages with FCMessage.ESeverity.WARN.

isTreatNonExistingVariablesAsError

boolean isTreatNonExistingVariablesAsError()

Returns:

true to create messages with severity FCMessage.ESeverity.ERROR when a variable that occurs in the expression does not exist, or false to create messages with FCMessage.ESeverity.WARN.