Class FcDoiVerifiedBpmnModeler
java.lang.Object
de.xima.fc.workflow.bpmn.AStartEventBpmnModeler<FcDoiVerifiedProps>
de.xima.fc.workflow.bpmn.AMessageStartEventBpmnModeler<FcDoiVerifiedProps>
de.xima.fc.workflow.designer.bpmn.trigger.FcDoiVerifiedBpmnModeler
- All Implemented Interfaces:
IWorkflowTriggerBpmnModeler<FcDoiVerifiedProps>
public final class FcDoiVerifiedBpmnModeler
extends AMessageStartEventBpmnModeler<FcDoiVerifiedProps>
BPMN modeler for triggers of type double opt-in verified.- Since:
- 8.4.0
-
Nested Class Summary
Nested classes/interfaces inherited from class AStartEventBpmnModeler
AStartEventBpmnModeler.IStatefulStartEventPostProcessor -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IWorkflowTriggerBpmnModeler<FcDoiVerifiedProps> The immutable singleton instance of this modeler. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected StringcreateDetails(IModelWorkflowTriggerParams<FcDoiVerifiedProps> params, IWorkflowBpmnModelContext context, IBoundMessageLocalizer localizer) Creates additional details regarding the configuration of the start event.protected StringcreateName(IModelWorkflowTriggerParams<FcDoiVerifiedProps> params, IWorkflowBpmnModelContext context, IBoundMessageLocalizer localizer) Creates the name of the start event in the BPMN model.protected StringgetInterfaceName(IModelWorkflowTriggerParams<FcDoiVerifiedProps> params, IWorkflowBpmnModelContext context) The technical name of theInterfacethe declares theoperationusedbythemessage event.protected QNamegetMessageStructure(IModelWorkflowTriggerParams<FcDoiVerifiedProps> params, IWorkflowBpmnModelContext context) protected StringgetMessageType(IModelWorkflowTriggerParams<FcDoiVerifiedProps> params, IWorkflowBpmnModelContext context) Gets the internal identifier of theMessagethat triggers thestart event.protected StringgetOperationName(IModelWorkflowTriggerParams<FcDoiVerifiedProps> params, IWorkflowBpmnModelContext context) The technical name of theOperationusedbythemessage event.Methods inherited from class AMessageStartEventBpmnModeler
createEventDefinition, getMessageNameMethods inherited from class AStartEventBpmnModeler
createStartEventLayoutPostProcessor, modelTrigger
-
Field Details
-
INSTANCE
The immutable singleton instance of this modeler.
-
-
Constructor Details
-
FcDoiVerifiedBpmnModeler
public FcDoiVerifiedBpmnModeler()
-
-
Method Details
-
createDetails
protected String createDetails(IModelWorkflowTriggerParams<FcDoiVerifiedProps> params, IWorkflowBpmnModelContext context, IBoundMessageLocalizer localizer) Description copied from class:AStartEventBpmnModelerCreates additional details regarding the configuration of the start event. These details are included in thetext annotationof the start event, usually placed above the rectangle that represents the task in the BPMN diagram.- Overrides:
createDetailsin classAStartEventBpmnModeler<FcDoiVerifiedProps>- 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 theboundMessageLocalizerobtained from thecontext.- Returns:
- The details of the start event in the BPMN model.
-
createName
protected String createName(IModelWorkflowTriggerParams<FcDoiVerifiedProps> params, IWorkflowBpmnModelContext context, IBoundMessageLocalizer localizer) Description copied from class:AStartEventBpmnModelerCreates the name of the start event in the BPMN model. This is thenameof thestart 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, seecreateDetails.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
- Draft to be reviewed
- 15 minutes
- Job announcement ready to be published
- Specified by:
createNamein classAStartEventBpmnModeler<FcDoiVerifiedProps>- 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 theboundMessageLocalizerobtained from thecontext.- Returns:
- The name of the service task in the BPMN model.
-
getInterfaceName
protected String getInterfaceName(IModelWorkflowTriggerParams<FcDoiVerifiedProps> params, IWorkflowBpmnModelContext context) Description copied from class:AMessageStartEventBpmnModelerThe technical name of theInterfacethe declares theoperationusedbythemessage event.- Specified by:
getInterfaceNamein classAMessageStartEventBpmnModeler<FcDoiVerifiedProps>- 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<FcDoiVerifiedProps> params, IWorkflowBpmnModelContext context) Description copied from class:AMessageStartEventBpmnModeler- Specified by:
getMessageStructurein classAMessageStartEventBpmnModeler<FcDoiVerifiedProps>- 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<FcDoiVerifiedProps> params, IWorkflowBpmnModelContext context) Description copied from class:AMessageStartEventBpmnModelerGets the internal identifier of theMessagethat triggers thestart event.- Specified by:
getMessageTypein classAMessageStartEventBpmnModeler<FcDoiVerifiedProps>- 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<FcDoiVerifiedProps> params, IWorkflowBpmnModelContext context) Description copied from class:AMessageStartEventBpmnModelerThe technical name of theOperationusedbythemessage event.- Specified by:
getOperationNamein classAMessageStartEventBpmnModeler<FcDoiVerifiedProps>- 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.
-