Package de.xima.fc.workflow.designer.bpmn.trigger

Class FcTimePointBpmnModeler

java.lang.Object

de.xima.fc.workflow.bpmn.AStartEventBpmnModeler<Model>

de.xima.fc.workflow.bpmn.ATimerStartEventBpmnModeler<FcTimePointProps>

de.xima.fc.workflow.designer.bpmn.trigger.FcTimePointBpmnModeler

All Implemented Interfaces:

IWorkflowTriggerBpmnModeler<FcTimePointProps>

public final class FcTimePointBpmnModeler
extends ATimerStartEventBpmnModeler<FcTimePointProps>

BPMN modeler for triggers of type time point.

Since:

8.4.0

Nested Class Summary

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

AStartEventBpmnModeler.IStatefulStartEventPostProcessor

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
FcTimePointBpmnModeler()

Method Summary

Modifier and Type	Method	Description
protected String	createDetails(IModelWorkflowTriggerParams<FcTimePointProps> params, IWorkflowBpmnModelContext context, IBoundMessageLocalizer localizer)	Creates additional details regarding the configuration of the start event.
protected String	createName(IModelWorkflowTriggerParams<FcTimePointProps> params, IWorkflowBpmnModelContext context, IBoundMessageLocalizer localizer)	Creates the name of the start event in the BPMN model.
protected AStartEventBpmnModeler.IStatefulStartEventPostProcessor	createStartEventLayoutPostProcessor(IModelWorkflowTriggerParams<FcTimePointProps> params, IWorkflowBpmnModelContext context)	Creates a post-processor for the start event layout.
protected TimerEventExpression	createTimerEventExpression(IModelWorkflowTriggerParams<FcTimePointProps> params, IWorkflowBpmnModelContext context)

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

createEventDefinition

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

modelTrigger

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final IWorkflowTriggerBpmnModeler<FcTimePointProps> INSTANCE

The immutable singleton instance of this modeler.

Constructor Detail

FcTimePointBpmnModeler

public FcTimePointBpmnModeler()

Method Detail

createDetails

protected String createDetails(IModelWorkflowTriggerParams<FcTimePointProps> params,
                               IWorkflowBpmnModelContext context,
                               IBoundMessageLocalizer localizer)

Description copied from class: AStartEventBpmnModeler

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

Overrides:

createDetails in class AStartEventBpmnModeler<FcTimePointProps>

Parameters:

params - The parameters with the trigger 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 start event in the BPMN model.

createName

protected String createName(IModelWorkflowTriggerParams<FcTimePointProps> params,
                            IWorkflowBpmnModelContext context,
                            IBoundMessageLocalizer localizer)

Description copied from class: AStartEventBpmnModeler

Creates the name of the start event in the BPMN model. This is the name of the start event, usually placed below the circle that represents the start event in the BPMN diagram.

The circle always has a defined diameter, 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 event. Details about the event should be included in the event's annotation, see createDetails.

By convention, name an event using an object and a verb reflecting a state. Always try to describe which state an object is in when the process is about to leave the event, e.g.:

• Draft reviewed
• Invoice checked
• Job announced

This naming approach does not always work perfectly. In those cases, precisely describe the business semantics when the process is about to leave the event. The following names are also valid:

• Draft to be reviewed
• 15 minutes
• Job announcement ready to be published

Specified by:

createName in class AStartEventBpmnModeler<FcTimePointProps>

Parameters:

params - The parameters with the trigger 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.

createStartEventLayoutPostProcessor

protected AStartEventBpmnModeler.IStatefulStartEventPostProcessor createStartEventLayoutPostProcessor(IModelWorkflowTriggerParams<FcTimePointProps> params,
                                                                                                      IWorkflowBpmnModelContext context)

Description copied from class: AStartEventBpmnModeler

Creates a post-processor for the start event layout. This allows you to enrich the start event with additional data and BPMN elements, such as adding an additional precondition for the start event. The default implementation returns a no-op post-processor that does enrich the task in any way.

Usually you should create a new instance for each call to this method. This instance does not need to be thread-safe and is used only for the duration of a single modeling operation. The instance may store state that is accessed by its various methods.

Overrides:

createStartEventLayoutPostProcessor in class AStartEventBpmnModeler<FcTimePointProps>

Parameters:

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

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

Returns:

A post-processor for the start event layout, never null. The default implementation returns a no-op processor that does not enrich the start event in any way.

createTimerEventExpression

protected TimerEventExpression createTimerEventExpression(IModelWorkflowTriggerParams<FcTimePointProps> params,
                                                          IWorkflowBpmnModelContext context)

Specified by:

createTimerEventExpression in class ATimerStartEventBpmnModeler<FcTimePointProps>