Package de.xima.fc.workflow.processor.factory

Interface IFcForEachLoopsPropsBuilder

All Superinterfaces:

IWorkflowElementBuilder<WorkflowNode,FcForEachLoopProps>

public interface IFcForEachLoopsPropsBuilder
extends IWorkflowElementBuilder<WorkflowNode,FcForEachLoopProps>

A builder for a workflow node of type EWorkflowNodeType.FC_FOR_EACH_LOOP that loops over a fixed collection of elements.

Since:

8.3.3

Method Summary

Modifier and Type	Method	Description
IFcForEachLoopsPropsBuilder	body(WorkflowNode... body)	Sets the child nodes to execute once for each element in the collection.
default IFcForEachLoopsPropsBuilder	body(Iterable<WorkflowNode> body)	Sets the child nodes to execute once for each element in the collection.
IFcForEachLoopsPropsBuilder	description(String description)	Sets the description of the node.
IFcForEachLoopsPropsBuilder	name(String name)	Sets the name of the node.
IFcForEachLoopsPropsBuilder	sourceJson(String json)	Loops over a JSON value, usually an array (its items) or object (its entries).
IFcForEachLoopsPropsBuilder	sourceJsonValue(Object json)	Loops over a JSON value, usually an array (its items) or object (its entries).
IFcForEachLoopsPropsBuilder	sourceProps(AListItemSourceProps sourceProps)	Sets the source properties of the node that define the collection to loop over.
IFcForEachLoopsPropsBuilder	sourceRepeatedFormField(String formFieldName)	Loops over a form field that is a repeated form field.

Methods inherited from interface de.xima.fc.workflow.processor.factory.IWorkflowElementBuilder

build, buildProps

Method Detail

body

default IFcForEachLoopsPropsBuilder body(Iterable<WorkflowNode> body)

Sets the child nodes to execute once for each element in the collection.

Can be any node or list of nodes. When not a single node of type EWorkflowNodeType.SEQUENCE, the node or nodes are wrapped in a sequence node.

Parameters:

body - The child nodes to execute.

Returns:

This builder for chaining method calls.

body

IFcForEachLoopsPropsBuilder body(WorkflowNode... body)

Sets the child nodes to execute once for each element in the collection.

Can be any node or list of nodes. When not a single node of type EWorkflowNodeType.SEQUENCE, the node or nodes are wrapped in a sequence node.

Parameters:

body - The child nodes to execute.

Returns:

This builder for chaining method calls.

description

IFcForEachLoopsPropsBuilder description(String description)

Sets the description of the node.

Parameters:

description - The description of the node.

Returns:

This builder for chaining method calls.

name

IFcForEachLoopsPropsBuilder name(String name)

Sets the name of the node.

Parameters:

name - The name of the node.

Returns:

This builder for chaining method calls.

sourceJson

IFcForEachLoopsPropsBuilder sourceJson(String json)

Loops over a JSON value, usually an array (its items) or object (its entries). For any other JSON value, loops over that single element.

Parameters:

json - The string representation of the JSON value to loop over.

Returns:

This builder for chaining method calls.

sourceJsonValue

IFcForEachLoopsPropsBuilder sourceJsonValue(Object json)

Loops over a JSON value, usually an array (its items) or object (its entries). For any other JSON value, loops over that single element.

Parameters:

json - The JSON value to loop over.

Returns:

This builder for chaining method calls.

sourceProps

IFcForEachLoopsPropsBuilder sourceProps(AListItemSourceProps sourceProps)

Sets the source properties of the node that define the collection to loop over.

Parameters:

sourceProps - The source properties of the node.

Returns:

This builder for chaining method calls.

sourceRepeatedFormField

IFcForEachLoopsPropsBuilder sourceRepeatedFormField(String formFieldName)

Loops over a form field that is a repeated form field. Can be a repeated container or a field inside a repeated container.

Parameters:

formFieldName - The name of the form field to loop over.

Returns:

This builder for chaining method calls.