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

Interface IWithFormElementContextNodeBuilder

All Superinterfaces:

IWorkflowElementBuilder<WorkflowNode,FcWithFormElementContextProps>

public interface IWithFormElementContextNodeBuilder
extends IWorkflowElementBuilder<WorkflowNode,FcWithFormElementContextProps>

Builder for configuring a with form element context workflow action (FC_WITH_FORM_ELEMENT_CONTEXT).

Since:

8.5.0

Method Summary

Modifier and Type	Method	Description
IWithFormElementContextNodeBuilder	addFieldValue(Setting<String> fieldValue)	Adds a form element field value context to apply during the execution of the child node.
IWithFormElementContextNodeBuilder	addFieldValue(String fieldName, int index)	Adds a form element field value context to apply during the execution of the child node.
IWithFormElementContextNodeBuilder	addFieldValue(String fieldName, long index)	Adds a form element field value context to apply during the execution of the child node.
IWithFormElementContextNodeBuilder	addFieldValue(String fieldName, String index)	Adds a form element field value context to apply during the execution of the child node.
IWithFormElementContextNodeBuilder	addRepetition(Setting<String> repetition)	Adds a form element repetition context to apply during the execution of the child node.
IWithFormElementContextNodeBuilder	addRepetition(String fieldName, int index)	Adds a form element repetition context to apply during the execution of the child node.
IWithFormElementContextNodeBuilder	addRepetition(String fieldName, long index)	Adds a form element repetition context to apply during the execution of the child node.
IWithFormElementContextNodeBuilder	addRepetition(String fieldName, String index)	Adds a form element repetition context to apply during the execution of the child node.
IWithFormElementContextNodeBuilder	body(WorkflowNode body)	Sets the body that will be executed with the form element context.
IWithFormElementContextNodeBuilder	fieldValues(List<Setting<String>> fieldValues)	Sets the form element field value contexts to apply during the execution of the child node.
IWithFormElementContextNodeBuilder	repetitions(List<Setting<String>> repetitions)	Sets the form element repetition contexts to apply during the execution of the child node.

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

build, buildProps

Method Detail

addFieldValue

IWithFormElementContextNodeBuilder addFieldValue(String fieldName,
                                                 int index)

Adds a form element field value context to apply during the execution of the child node.

Parameters:

fieldName - The name of the form element field for which to set the context. Blank names will be ignored. May contain placeholders.

index - The field value index to set as context for the field. Negative indices will be ignored.

Returns:

This builder for chaining method calls.

addFieldValue

IWithFormElementContextNodeBuilder addFieldValue(String fieldName,
                                                 long index)

Adds a form element field value context to apply during the execution of the child node.

Parameters:

fieldName - The name of the form element field for which to set the context. Blank names will be ignored. May contain placeholders.

index - The field value index to set as context for the field. Negative indices will be ignored.

Returns:

This builder for chaining method calls.

addFieldValue

IWithFormElementContextNodeBuilder addFieldValue(String fieldName,
                                                 String index)

Adds a form element field value context to apply during the execution of the child node.

Parameters:

fieldName - The name of the form element field for which to set the context. Blank names will be ignored. May contain placeholders.

index - The field value index to set as context for the field. Negative indices will be ignored. May contain placeholders.

Returns:

This builder for chaining method calls.

addFieldValue

IWithFormElementContextNodeBuilder addFieldValue(Setting<String> fieldValue)

Adds a form element field value context to apply during the execution of the child node.

Parameters:

fieldValue - The field name and field value index to set as context for the field. May contain placeholders.

Returns:

This builder for chaining method calls.

addRepetition

IWithFormElementContextNodeBuilder addRepetition(String fieldName,
                                                 int index)

Adds a form element repetition context to apply during the execution of the child node.

Parameters:

fieldName - The name of the repeated form element for which to set the context. Blank names will be ignored. May contain placeholders.

index - The repetition index to set as context for the field. Negative indices will be ignored.

Returns:

This builder for chaining method calls.

addRepetition

IWithFormElementContextNodeBuilder addRepetition(String fieldName,
                                                 long index)

Adds a form element repetition context to apply during the execution of the child node.

Parameters:

fieldName - The name of the repeated form element for which to set the context. Blank names will be ignored. May contain placeholders.

index - The repetition index to set as context for the field. Negative indices will be ignored.

Returns:

This builder for chaining method calls.

addRepetition

IWithFormElementContextNodeBuilder addRepetition(String fieldName,
                                                 String index)

Adds a form element repetition context to apply during the execution of the child node.

Parameters:

fieldName - The name of the repeated form element for which to set the context. Blank names will be ignored. May contain placeholders.

index - The repetition index to set as context for the field. Negative indices will be ignored. May contain placeholders.

Returns:

This builder for chaining method calls.

addRepetition

IWithFormElementContextNodeBuilder addRepetition(Setting<String> repetition)

Adds a form element repetition context to apply during the execution of the child node.

Parameters:

repetition - The field name and repetition index to set as context for the field. May contain placeholders.

Returns:

This builder for chaining method calls.

body

IWithFormElementContextNodeBuilder body(WorkflowNode body)

Sets the body that will be executed with the form element context. When not a sequence node, will be wrapped in a sequence node. Defaults to an empty sequence.

Parameters:

body - The body to execute with the form element context.

Returns:

This builder for chaining method calls.

fieldValues

IWithFormElementContextNodeBuilder fieldValues(List<Setting<String>> fieldValues)

Sets the form element field value contexts to apply during the execution of the child node.

Parameters:

fieldValues - A list with the index for each field name. May contain placeholders.

Returns:

This builder for chaining method calls.

repetitions

IWithFormElementContextNodeBuilder repetitions(List<Setting<String>> repetitions)

Sets the form element repetition contexts to apply during the execution of the child node.

Parameters:

repetitions - A list with the index for each field name. May contain placeholders.

Returns:

This builder for chaining method calls.