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

Class FcStateTimerBpmnModeler

java.lang.Object

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

de.xima.fc.workflow.bpmn.AMessageStartEventBpmnModeler<FcStateTimerProps>

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

All Implemented Interfaces:

IWorkflowTriggerBpmnModeler<FcStateTimerProps>

public final class FcStateTimerBpmnModeler
extends AMessageStartEventBpmnModeler<FcStateTimerProps>

BPMN modeler for triggers of type state timer.

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<FcStateTimerProps>	INSTANCE	The immutable singleton instance of this modeler.

Constructor Summary

Constructors

Constructor	Description
FcStateTimerBpmnModeler()

Method Summary

Modifier and Type	Method	Description
protected String	createDetails(IModelWorkflowTriggerParams<FcStateTimerProps> params, IWorkflowBpmnModelContext context, IBoundMessageLocalizer localizer)	Creates additional details regarding the configuration of the start event.
protected String	createName(IModelWorkflowTriggerParams<FcStateTimerProps> params, IWorkflowBpmnModelContext context, IBoundMessageLocalizer localizer)	Creates the name of the start event in the BPMN model.
protected String	getInterfaceName(IModelWorkflowTriggerParams<FcStateTimerProps> params, IWorkflowBpmnModelContext context)	The technical name of the Interface the declares the operation used by the message event.
protected QName	getMessageStructure(IModelWorkflowTriggerParams<FcStateTimerProps> params, IWorkflowBpmnModelContext context)	Gets the structure (type) of the Message that triggers the start event.
protected String	getMessageType(IModelWorkflowTriggerParams<FcStateTimerProps> params, IWorkflowBpmnModelContext context)	Gets the internal identifier of the Message that triggers the start event.
protected String	getOperationName(IModelWorkflowTriggerParams<FcStateTimerProps> params, IWorkflowBpmnModelContext context)	The technical name of the Operation used by the message event.

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

createEventDefinition, getMessageName

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

createStartEventLayoutPostProcessor, 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<FcStateTimerProps> INSTANCE

The immutable singleton instance of this modeler.

Constructor Detail

FcStateTimerBpmnModeler

public FcStateTimerBpmnModeler()

Method Detail

createDetails

protected String createDetails(IModelWorkflowTriggerParams<FcStateTimerProps> 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<FcStateTimerProps>

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<FcStateTimerProps> 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<FcStateTimerProps>

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.

getInterfaceName

protected String getInterfaceName(IModelWorkflowTriggerParams<FcStateTimerProps> params,
                                  IWorkflowBpmnModelContext context)

Description copied from class: AMessageStartEventBpmnModeler

The technical name of the Interface the declares the operation used by the message event.

Specified by:

getInterfaceName in class AMessageStartEventBpmnModeler<FcStateTimerProps>

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:

The name of the interface.

getMessageStructure

protected QName getMessageStructure(IModelWorkflowTriggerParams<FcStateTimerProps> params,
                                    IWorkflowBpmnModelContext context)

Description copied from class: AMessageStartEventBpmnModeler

Gets the structure (type) of the Message that triggers the start event.

Specified by:

getMessageStructure in class AMessageStartEventBpmnModeler<FcStateTimerProps>

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:

The structure of the message.

getMessageType

protected String getMessageType(IModelWorkflowTriggerParams<FcStateTimerProps> params,
                                IWorkflowBpmnModelContext context)

Description copied from class: AMessageStartEventBpmnModeler

Gets the internal identifier of the Message that triggers the start event.

Specified by:

getMessageType in class AMessageStartEventBpmnModeler<FcStateTimerProps>

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:

The type of the message, which is used to identify the message in the BPMN model.

getOperationName

protected String getOperationName(IModelWorkflowTriggerParams<FcStateTimerProps> params,
                                  IWorkflowBpmnModelContext context)

Description copied from class: AMessageStartEventBpmnModeler

The technical name of the Operation used by the message event.

Specified by:

getOperationName in class AMessageStartEventBpmnModeler<FcStateTimerProps>

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:

The name of the operation.