ee.telekom.workflow.api

Interface DslBlock<Level>

All Superinterfaces:

DslExpression<Level>

All Known Subinterfaces:

DslBranchBlock<Level>, DslDoWhileBlock<Level>, DslElseBlock<Level>, DslIfBlock<Level>, DslMainBlock<Level>, DslValidationBlock<Level>, DslWhileDoBlock<Level>

public interface DslBlock<Level>
extends DslExpression<Level>

DSL for workflow definitions.

Author:

Erko Hansar, Christian Klock

See Also:

WorkflowDefinition

Method Summary

Modifier and Type	Method and Description
DslAttribute<Level>	createInstance(int id, String workflowName, Integer workflowVersion, String label1, String label2) Creates a new workflow instance based.
DslDoWhileBlock<Level>	doWhile() Start tag for a do-while block.
DslIfBlock<Level>	if_(int id, String condition) Start tag for if-elseIf-else-endIf block.
DslSplit<Level>	split(int id) Start tag for splitting the execution into multiple parallel branches.
DslVariable<Level>	variable(String name) Set an environment variable with the given name.
DslVariable<Level>	variables(String... nameMappings) Set environment variable with the given names.
Level	waitTimer(int id, String due) Wait until a defined time period has passed.
Level	waitUntilDate(int id, String due) Wait until a defined date has been reached
DslWhileDoBlock<Level>	whileDo(int id, String condition) While the given condition is true, execute the block content and then check again.

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

call, callAsync, humanTask, waitSignal

Method Detail

variable

DslVariable<Level> variable(String name)

Set an environment variable with the given name. The value comes from the next immediate node (value, call, callAsync, humanTask, waitSignal).

Parameters:

name - name of the environment variable which is going to be set

variables

DslVariable<Level> variables(String... nameMappings)

Set environment variable with the given names. The value comes from the next immediate node (value, call, callAsync, humanTask, waitSignal). Used when the value returning node return a Map result and we want to store one or more key-value pairs from this Map directly into the environment (instead of storing the whole Map under a new variable name and then accessing the key-value pairs as subfields inside this Map value).

If the returned Map contains 3 keys: x, y and z, then the call .variables( "a=x", "b=y" ) should be read as: take x from method call result map and store it into environment as a, and take y from method call result map and store it into environment as b, and ignore z.

Parameters:

nameMappings - desired mappings of the environment variable: new_environment_variable_name=returned_map_key_name

createInstance

DslAttribute<Level> createInstance(int id,
                                   String workflowName,
                                   Integer workflowVersion,
                                   String label1,
                                   String label2)

Creates a new workflow instance based.

Parameters:

id - node id

workflowName - the workflow's name to be created ("STRING_WORKFLOW_NAME" or "${EL_EXPRESSION}")

workflowVersion - the workflow's version to be created or null for the latest

label1 - first label ("STRING_LABEL" or "${EL_EXPRESSION}")

label2 - second label ("STRING_LABEL" or "${EL_EXPRESSION}")

waitTimer

Level waitTimer(int id,
                String due)

Wait until a defined time period has passed.

### WAIT STATE ###

Parameters:

id - node id

due - either a constant Long value of milliseconds or an EL expression which returns the milliseconds ("LONG_VALUE" or "${EL_EXPRESSION}")

waitUntilDate

Level waitUntilDate(int id,
                    String due)

Wait until a defined date has been reached

### WAIT STATE ###

Parameters:

id - node id

due - an EL expression which returns the date ("${EL_EXPRESSION}")

whileDo

DslWhileDoBlock<Level> whileDo(int id,
                               String condition)

While the given condition is true, execute the block content and then check again.

Block start tag.

Parameters:

id - node id

condition - expression language condition ("EL_EXPRESSION")

doWhile

DslDoWhileBlock<Level> doWhile()

Start tag for a do-while block. Execution continues into the block content.

if_

DslIfBlock<Level> if_(int id,
                      String condition)

Start tag for if-elseIf-else-endIf block. If the given condition evaluates to true, then executes the branch content and ignores the other elseIf and else branches, otherwise evaluates the following elseIf or else condition.

The if-elseIf-else-endIf block executes only one of it's branches.

Parameters:

id - node id

condition - expression language condition ("EL_EXPRESSION")

split

DslSplit<Level> split(int id)

Start tag for splitting the execution into multiple parallel branches.

Parameters:

id - node id