ee.telekom.workflow.api

Interface DslValidationBlock<Level>

All Superinterfaces:

DslBlock<DslMainBlock<Level>>, DslExpression<DslMainBlock<Level>>, DslMainBlock<Level>

public interface DslValidationBlock<Level>
extends DslMainBlock<Level>

DSL for workflow definitions.

Author:

Erko Hansar, Christian Klock

See Also:

WorkflowDefinition

Method Summary

Modifier and Type	Method and Description
DslValidationBlock<Level>	validateInputVariable(int id, String variable, Class<?> type) Checks a required input value.
DslValidationBlock<Level>	validateInputVariable(int id, String variable, Class<?> type, boolean isRequired) Like validateInputVariable(int, String, Class, boolean, Object) with a default value of null
DslValidationBlock<Level>	validateInputVariable(int id, String variable, Class<?> type, boolean isRequired, Object defaultValue) Checks a required or optional input value.

Methods inherited from interface ee.telekom.workflow.api.DslMainBlock

end

Methods inherited from interface ee.telekom.workflow.api.DslBlock

createInstance, doWhile, if_, split, variable, variables, waitTimer, waitUntilDate, whileDo

Methods inherited from interface ee.telekom.workflow.api.DslExpression

call, callAsync, humanTask, waitSignal

Method Detail

validateInputVariable

DslValidationBlock<Level> validateInputVariable(int id,
                                                String variable,
                                                Class<?> type)

Checks a required input value. Tests that the input variable's value is set in the environment (possibly also to null) and that this value is assignable to the defined type. NB! Calls to one of the overloaded validateInputVariable methods are only possible at the beginning of the workflow definition.

Parameters:

id - node id

variable - variable name

type - type that the variable's value must be assignable to.

validateInputVariable

DslValidationBlock<Level> validateInputVariable(int id,
                                                String variable,
                                                Class<?> type,
                                                boolean isRequired)

Like validateInputVariable(int, String, Class, boolean, Object) with a default value of null

validateInputVariable

DslValidationBlock<Level> validateInputVariable(int id,
                                                String variable,
                                                Class<?> type,
                                                boolean isRequired,
                                                Object defaultValue)

Checks a required or optional input value. For a required input variable, it checks that the variable's value is set in the environment (possibly also to null) and that this value is assignable to the defined type. For an optional input variable, it initialises the value to a default, if it is not yet set in the environment and ensures that its value is assignable to the defined type. NB! Calls to one of the overloaded validateInputVariable methods are only possible at the beginning of the workflow definition.

Parameters:

id - node id

variable - variable name

type - type that the variable's value must be assignable to

isRequired - whether the variable is a required or an optional input

defaultValue - a default value if the optional input value is not given