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

Class FcMultipleConditionBpmnModeler

java.lang.Object

de.xima.fc.workflow.bpmn.ABinarySelectionBpmnModeler<FcMultipleConditionProps>

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

All Implemented Interfaces:

IWorkflowNodeBpmnModeler<FcMultipleConditionProps>

public final class FcMultipleConditionBpmnModeler
extends ABinarySelectionBpmnModeler<FcMultipleConditionProps>

BPMN modeler for nodes of type sequence. Aligns the consequent and alternate parts in cross-flow direction, the creates a diverging and converging gateway for and places the parts between them:

Since:

8.4.0

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
protected int	getAlternateChildIndex()	Gets the 0-based index of the child representing the alternate (else) part.
protected String	getAlternateLabel(IModelWorkflowNodeParams<FcMultipleConditionProps> params, IWorkflowBpmnModelContext context)	Gets the label for the alternate part, which is displayed next to the outgoing sequence flow of the exclusive gateway.
protected String	getConditionDetails(IModelWorkflowNodeParams<FcMultipleConditionProps> params, IWorkflowBpmnModelContext context)	Gets the detailed description of the condition that is evaluated to determine which branch to take.
protected String	getConditionName(IModelWorkflowNodeParams<FcMultipleConditionProps> params, IWorkflowBpmnModelContext context)	Gets the name of the condition, uses as the name of the diverging exclusive gateway.
protected int	getConsequentChildIndex()	Gets the 0-based index of the child representing the consequent (if) part.
protected String	getConsequentLabel(IModelWorkflowNodeParams<FcMultipleConditionProps> params, IWorkflowBpmnModelContext context)	Gets the label for the consequent part, which is displayed next to the outgoing sequence flow of the exclusive gateway.

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

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<FcMultipleConditionProps> INSTANCE

The immutable singleton instance of this modeler.

Method Detail

getAlternateChildIndex

protected int getAlternateChildIndex()

Description copied from class: ABinarySelectionBpmnModeler

Gets the 0-based index of the child representing the alternate (else) part.

Overrides:

getAlternateChildIndex in class ABinarySelectionBpmnModeler<FcMultipleConditionProps>

Returns:

0-based index of the alternate child.

getAlternateLabel

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

Description copied from class: ABinarySelectionBpmnModeler

Gets the label for the alternate part, which 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 ABinarySelectionBpmnModeler<FcMultipleConditionProps>

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<FcMultipleConditionProps> params,
                                     IWorkflowBpmnModelContext context)

Description copied from class: ABinarySelectionBpmnModeler

Gets the detailed description of the condition that is evaluated to determine which branch to take. 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 ABinarySelectionBpmnModeler<FcMultipleConditionProps>

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<FcMultipleConditionProps> params,
                                  IWorkflowBpmnModelContext context)

Description copied from class: ABinarySelectionBpmnModeler

Gets the name of the condition, 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 ABinarySelectionBpmnModeler<FcMultipleConditionProps>

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.

getConsequentChildIndex

protected int getConsequentChildIndex()

Description copied from class: ABinarySelectionBpmnModeler

Gets the 0-based index of the child representing the consequent (if) part.

Overrides:

getConsequentChildIndex in class ABinarySelectionBpmnModeler<FcMultipleConditionProps>

Returns:

0-based index of the consequent child.

getConsequentLabel

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

Description copied from class: ABinarySelectionBpmnModeler

Gets the label for the consequent part, which 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 ABinarySelectionBpmnModeler<FcMultipleConditionProps>

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.