Package de.xima.fc.workflow.model.nodes

Class FcWithFormElementContextProps

java.lang.Object

de.xima.fc.workflow.model.nodes.FcWithFormElementContextProps

All Implemented Interfaces:

Serializable

public final class FcWithFormElementContextProps
extends Object
implements Serializable

Model class for the with form element context workflow action (EWorkflowNodeType.FC_WITH_FORM_ELEMENT_CONTEXT).

Since:

8.5.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
FcWithFormElementContextProps()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the internal description of the with form element context node.
List<Setting<String>>	getFieldValues()	Gets the list of (field name, index) pairs indicating the form element field value contexts to set during the execution of the child node.
List<Setting<String>>	getRepetitions()	Gets the list of (field name, index) pairs indicating the form element repetition contexts to set during the execution of the child node.
void	setDescription(String description)	Sets the internal description of the with form element context node.
void	setFieldValues(List<Setting<String>> fieldValues)	Sets the list of (field name, index) pairs indicating the form element field value contexts to set during the execution of the child node.
void	setRepetitions(List<Setting<String>> repetitions)	Sets the list of (field name, index) pairs indicating the form element repetition contexts to set during the execution of the child node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FcWithFormElementContextProps

public FcWithFormElementContextProps()

Method Detail

getDescription

public String getDescription()

Gets the internal description of the with form element context node. The internal description is only shown to backend users in the workflow editor and can be used to provide additional information about the node or an explanation of its purpose. This may help other editors to understand the workflow better. The description is not shown to frontend users.

Returns:

The node's internal description.

setDescription

public void setDescription(String description)

Sets the internal description of the with form element context node. The internal description is only shown to backend users in the workflow editor and can be used to provide additional information about the node or an explanation of its purpose. This may help other editors to understand the workflow better. The description is not shown to frontend users.

Parameters:

description - The node's internal description.

getFieldValues

public List<Setting<String>> getFieldValues()

Gets the list of (field name, index) pairs indicating the form element field value contexts to set during the execution of the child node. Blank names and out of bounds indices will be ignored. For example, if set to [(sel1, 1), (sel2, 2)] and sel1 and sel2 are multi-choice select form elements, then during the execution of the form element context node: the placeholder [%sel1%] will evaluate to the second selected value of "sel1"; the placeholder [%sel2%] will evaluate to the third selected value of "sel2".

Returns:

A list with the index for each field name.

setFieldValues

public void setFieldValues(List<Setting<String>> fieldValues)

Sets the list of (field name, index) pairs indicating the form element field value contexts to set during the execution of the child node. Blank names and out of bounds indices will be ignored. For example, if set to [(sel1, 1), (sel2, 2)] and sel1 and sel2 are multi-choice select form elements, then during the execution of the form element context node: the placeholder [%sel1%] will evaluate to the second selected value of "sel1"; the placeholder [%sel2%] will evaluate to the third selected value of "sel2".

Parameters:

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

getRepetitions

public List<Setting<String>> getRepetitions()

Gets the list of (field name, index) pairs indicating the form element repetition contexts to set during the execution of the child node. Blank names and out of bounds indices will be ignored. For example, if set to [(tf1, 1), (sel1, 2)] and tf1 and fs1 are repeated form elements, then during the execution of the form element context node: the placeholder [%tf1%] will evaluate to the value of the second repetition of "sel1"; the placeholder [%sel1%] will evaluate to the value of the third repetition of "sel1".

Returns:

A list with the index for each field name.

setRepetitions

public void setRepetitions(List<Setting<String>> repetitions)

Sets the list of (field name, index) pairs indicating the form element repetition contexts to set during the execution of the child node. Blank names and out of bounds indices will be ignored. For example, if set to [(tf1, 1), (sel1, 2)] and tf1 and fs1 are repeated form elements, then during the execution of the form element context node: the placeholder [%tf1%] will evaluate to the value of the second repetition of "sel1"; the placeholder [%sel1%] will evaluate to the value of the third repetition of "sel1".

Parameters:

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