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

Class FcChangeStateBpmnModeler

java.lang.Object

de.xima.fc.workflow.bpmn.AServiceTaskBpmnModeler<FcChangeStateProps>

de.xima.fc.workflow.designer.bpmn.node.action.FcChangeStateBpmnModeler

All Implemented Interfaces:

IWorkflowNodeBpmnModeler<FcChangeStateProps>

public final class FcChangeStateBpmnModeler
extends AServiceTaskBpmnModeler<FcChangeStateProps>

BPMN modeler for nodes of type change state.

Since:

8.4.0

Nested Class Summary

Nested classes/interfaces inherited from class de.xima.fc.workflow.bpmn.AServiceTaskBpmnModeler

AServiceTaskBpmnModeler.IStatefulTaskLayoutPostProcessor

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
protected String	createDescription(IModelWorkflowNodeParams<FcChangeStateProps> params, IWorkflowBpmnModelContext context, IBoundMessageLocalizer localizer)	Creates the additional description of the service task.
protected String	createDetails(IModelWorkflowNodeParams<FcChangeStateProps> params, IWorkflowBpmnModelContext context, IBoundMessageLocalizer localizer)	Creates additional details regarding the configuration of the service task.
protected String	createName(IModelWorkflowNodeParams<FcChangeStateProps> params, IWorkflowBpmnModelContext context, IBoundMessageLocalizer localizer)	Creates the name of the service task in the BPMN model.

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

createIoSpecification, createTaskLayoutPostProcessor, modelNode

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static IWorkflowNodeBpmnModeler<FcChangeStateProps> INSTANCE

The immutable singleton instance of this modeler.

Method Detail

createDescription

protected String createDescription(IModelWorkflowNodeParams<FcChangeStateProps> params,
                                   IWorkflowBpmnModelContext context,
                                   IBoundMessageLocalizer localizer)

Description copied from class: AServiceTaskBpmnModeler

Creates the additional description of the service task. The description is included in the text annotation of the service task, after the details.

The default implementation returns AWorkflowElement.getDescription().

Overrides:

createDescription in class AServiceTaskBpmnModeler<FcChangeStateProps>

Parameters:

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

context - The BPMN model context, as provided by the workflow engine.

localizer - The localizer to use for localizing the name. This is the same as the boundMessageLocalizer obtained from the context.

Returns:

The additional description of the service task, included in the text annotation after the details.

createDetails

protected String createDetails(IModelWorkflowNodeParams<FcChangeStateProps> params,
                               IWorkflowBpmnModelContext context,
                               IBoundMessageLocalizer localizer)

Description copied from class: AServiceTaskBpmnModeler

Creates additional details regarding the configuration of the service task. These details are included in the text annotation of the service task, usually placed above the rectangle that represents the task in the BPMN diagram.

Overrides:

createDetails in class AServiceTaskBpmnModeler<FcChangeStateProps>

Parameters:

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

context - The BPMN model context, as provided by the workflow engine.

localizer - The localizer to use for localizing the name. This is the same as the boundMessageLocalizer obtained from the context.

Returns:

The details of the service task in the BPMN model.

createName

protected String createName(IModelWorkflowNodeParams<FcChangeStateProps> params,
                            IWorkflowBpmnModelContext context,
                            IBoundMessageLocalizer localizer)

Description copied from class: AServiceTaskBpmnModeler

Creates the name of the service task in the BPMN model. This is the name of the service task, usually placed inside the rectangle that represents the task in the BPMN diagram.

The rectangle always has a defined width and height, independent of the name's length, so the name should be short and concise. If the name is too long, it may be truncated in the BPMN diagram. As a best practice, try not to include any user-configurable details in the name, simply use a static name that describes the type of action. Details about the action should be included in the task's annotation, see createDetails, and also createDescription.

By convention, name a task using an object and a verb in the infinitive. By doing this, you consistently describe what you do with an object. For example:

• Review draft
• Check invoice
• Announce job

Specified by:

createName in class AServiceTaskBpmnModeler<FcChangeStateProps>

Parameters:

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

context - The BPMN model context, as provided by the workflow engine.

localizer - The localizer to use for localizing the name. This is the same as the boundMessageLocalizer obtained from the context.

Returns:

The name of the service task in the BPMN model.