Package de.xima.fc.workflow.designer.bpmn.node.flow_control

Class FcWhileLoopBpmnModeler

java.lang.Object

de.xima.fc.workflow.bpmn.APreTestLoopBpmnModeler<FcWhileLoopProps>

de.xima.fc.workflow.designer.bpmn.node.flow_control.FcWhileLoopBpmnModeler

All Implemented Interfaces:

IWorkflowNodeBpmnModeler<FcWhileLoopProps>

public final class FcWhileLoopBpmnModeler
extends APreTestLoopBpmnModeler<FcWhileLoopProps>

BPMN modeler for nodes of type while loop. Uses an ExclusiveGateway to check if the loop condition is fulfilled. If not, redirects the sequence flow to the end of the loop.

Since:

8.4.0

Field Summary

Fields

Modifier and Type	Field	Description
static IWorkflowNodeBpmnModeler<FcWhileLoopProps>	INSTANCE	The immutable singleton instance of this modeler.

Method Summary

Modifier and Type	Method	Description
protected String	getAlternateLabel(IModelWorkflowNodeParams<FcWhileLoopProps> params, IWorkflowBpmnModelContext context)	Gets the label for when the condition does not match, ending the loop.
protected String	getConditionDetails(IModelWorkflowNodeParams<FcWhileLoopProps> params, IWorkflowBpmnModelContext context)	Gets the detailed description of the condition that is evaluated to determine when to end the loop.
protected String	getConditionName(IModelWorkflowNodeParams<FcWhileLoopProps> params, IWorkflowBpmnModelContext context)	Gets the name of the condition that checks when to end the loop.
protected String	getConsequentLabel(IModelWorkflowNodeParams<FcWhileLoopProps> params, IWorkflowBpmnModelContext context)	Gets the label for when the condition matches, which continues the loop.
protected int	getLoopBodyChildIndex()	Gets the 0-based index of the child representing the loop body.

Methods inherited from class de.xima.fc.workflow.bpmn.APreTestLoopBpmnModeler

modelNode

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final IWorkflowNodeBpmnModeler<FcWhileLoopProps> INSTANCE

The immutable singleton instance of this modeler.

Method Detail

getAlternateLabel

protected String getAlternateLabel(IModelWorkflowNodeParams<FcWhileLoopProps> params,
                                   IWorkflowBpmnModelContext context)

Description copied from class: APreTestLoopBpmnModeler

Gets the label for when the condition does not match, ending the loop. The label is displayed next to the outgoing sequence flow of the exclusive gateway.

When this returns a blank string, defaults to a default localized label that may or may not be appropriate for the specific circumstances of the workflow node being modelled.

Note regarding the naming convention for gateways. Label a data-based exclusive gateway with a question.

• Invoice correct?
• Trust level of user?

Label the outgoing sequence flows with the conditions they are executed under. Formulate the conditions as answers to the question posed at the gateway.

• Yes
• No
• Untrusted
• Basic
• Secure

Overrides:

getAlternateLabel in class APreTestLoopBpmnModeler<FcWhileLoopProps>

Parameters:

params - The parameters for the workflow node to model, as provided by the workflow engine.

context - The context for the BPMN modelling process, as provided by the workflow engine.

Returns:

The label for the alternate part.

getConditionDetails

protected String getConditionDetails(IModelWorkflowNodeParams<FcWhileLoopProps> params,
                                     IWorkflowBpmnModelContext context)

Description copied from class: APreTestLoopBpmnModeler

Gets the detailed description of the condition that is evaluated to determine when to end the loop. The description is placed within the text annotation of the diverging exclusive gateway. May return empty if no details are needed.

Overrides:

getConditionDetails in class APreTestLoopBpmnModeler<FcWhileLoopProps>

Parameters:

params - The parameters for the workflow node to model, as provided by the workflow engine.

context - The context for the BPMN modelling process, as provided by the workflow engine.

Returns:

The details description of the condition, may be empty if no condition is specified.

getConditionName

protected String getConditionName(IModelWorkflowNodeParams<FcWhileLoopProps> params,
                                  IWorkflowBpmnModelContext context)

Description copied from class: APreTestLoopBpmnModeler

Gets the name of the condition that checks when to end the loop. Uses as the name of the diverging exclusive gateway.

When this returns a blank string, defaults to a default localized name that may or may not be appropriate for the specific circumstances of the workflow node being modelled.

Note regarding the naming convention for gateways. Label a data-based exclusive gateway with a question.

• Invoice correct?
• Trust level of user?

Label the outgoing sequence flows with the conditions they are executed under. Formulate the conditions as answers to the question posed at the gateway.

• Yes
• No
• Untrusted
• Basic
• Secure

Overrides:

getConditionName in class APreTestLoopBpmnModeler<FcWhileLoopProps>

Parameters:

params - The parameters for the workflow node to model, as provided by the workflow engine.

context - The context for the BPMN modelling process, as provided by the workflow engine.

Returns:

The details description of the condition, may be empty if no condition is specified.

getConsequentLabel

protected String getConsequentLabel(IModelWorkflowNodeParams<FcWhileLoopProps> params,
                                    IWorkflowBpmnModelContext context)

Description copied from class: APreTestLoopBpmnModeler

Gets the label for when the condition matches, which continues the loop. The label is displayed next to the outgoing sequence flow of the exclusive gateway.

When this returns a blank string, defaults to a default localized label that may or may not be appropriate for the specific circumstances of the workflow node being modelled.

Note regarding the naming convention for gateways. Label a data-based exclusive gateway with a question.

• Invoice correct?
• Trust level of user?

Label the outgoing sequence flows with the conditions they are executed under. Formulate the conditions as answers to the question posed at the gateway.

• Yes
• No
• Untrusted
• Basic
• Secure

Overrides:

getConsequentLabel in class APreTestLoopBpmnModeler<FcWhileLoopProps>

Parameters:

params - The parameters for the workflow node to model, as provided by the workflow engine.

context - The context for the BPMN modelling process, as provided by the workflow engine.

Returns:

The label for the consequent part.

getLoopBodyChildIndex

protected int getLoopBodyChildIndex()

Description copied from class: APreTestLoopBpmnModeler

Gets the 0-based index of the child representing the loop body. The default implementation returns 0, i.e. the first child of the pre-test loop.

Overrides:

getLoopBodyChildIndex in class APreTestLoopBpmnModeler<FcWhileLoopProps>

Returns:

0-based index of the loop body.