Class AMessageStartEventBpmnModeler<Model>

java.lang.Object
de.xima.fc.workflow.bpmn.AStartEventBpmnModeler<Model>
de.xima.fc.workflow.bpmn.AMessageStartEventBpmnModeler<Model>
Type Parameters:
Model - Type of the trigger's custom parameters model.
All Implemented Interfaces:
IWorkflowTriggerBpmnModeler<Model>
Direct Known Subclasses:
FcCatchErrorBpmnModeler, FcDoiVerifiedBpmnModeler, FcFormRecordMessagePostedBpmnModeler, FcFormRecordMessageUploadRequestFulfilledBpmnModeler, FcFormSubmitButtonBpmnModeler, FcInvitationErrorBpmnModeler, FcInvitationSentBpmnModeler, FcManualBpmnModeler, FcQualifiedFormSubmitButtonBpmnModeler, FcStateTimerBpmnModeler, FcUserInvocationBpmnModeler
public abstract class AMessageStartEventBpmnModeler<Model> extends AStartEventBpmnModeler<Model>
Base class for BPMN modelers that can be represented as a message start event. You need to implement various methods regarding the message structure, type, and operation.
Since:
8.4.0

  • Constructor Details

    • AMessageStartEventBpmnModeler

      public AMessageStartEventBpmnModeler()

  • Method Details

    • createEventDefinition

      protected final List<de.xima.bpmn_model.api.element.bpmn.events.MessageEventDefinition> createEventDefinition(IModelWorkflowTriggerParams<Model> params, IWorkflowBpmnModelContext context, IBoundMessageLocalizer localizer)
      Description copied from class: AStartEventBpmnModeler
      Creates the event definitions for the start event in the BPMN model. This is usually only a single event definition. If multiple definitions are returned, the BPMN standard considers this a Multiple event. If no definitions are returned, the BPMN standard considers this as a None event.
      Specified by:
      createEventDefinition in class AStartEventBpmnModeler<Model>
      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:
      A list of event definitions for the start event in the BPMN model.

    • getInterfaceName

      protected abstract String getInterfaceName(IModelWorkflowTriggerParams<Model> params, IWorkflowBpmnModelContext context)
      The technical name of the Interface the declares the operation used by the message event.
      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.

    • getMessageName

      protected String getMessageName(IModelWorkflowTriggerParams<Model> params, IWorkflowBpmnModelContext context)
      Gets the technical name of the Message that triggers the start event. The default implementation returns the message type. You may override this method to provide a more descriptive name.
      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.

    • getMessageStructure

      protected abstract QName getMessageStructure(IModelWorkflowTriggerParams<Model> params, IWorkflowBpmnModelContext context)
      Gets the structure (type) of the Message that triggers the start event.
      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 abstract String getMessageType(IModelWorkflowTriggerParams<Model> params, IWorkflowBpmnModelContext context)
      Gets the internal identifier of the Message that triggers the start event.
      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 abstract String getOperationName(IModelWorkflowTriggerParams<Model> params, IWorkflowBpmnModelContext context)
      The technical name of the Operation used by the message event.
      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.