Interface IEventContainingStructuredBpmnModelPartBuilder<Self>

Type Parameters:
Self - The type of the builder.
All Known Subinterfaces:
IStructuredBpmnModelPartBuilder<Self>, IWorkflowNodeBpmnModelPartBuilder, IWorkflowProcessBpmnModelPartBuilder, IWorkflowTaskBpmnModelPartBuilder, IWorkflowTriggerBpmnModelPartBuilder
public interface IEventContainingStructuredBpmnModelPartBuilder<Self>
A IStructuredBpmnModelPartBuilder for parts that can contain events. Allows the events that can be raised to be declared.
Since:
8.4.0

  • Method Details

    • addRaisableError

      @CanIgnoreReturnValue Self addRaisableError(BpmnRaisableError error)
      Adds the error code of an error that can be raised by the part, see IStructuredBpmnModelPart.raisableErrors().
      Parameters:
      error - The error to add.
      Returns:
      This builder, for chaining.

    • addRaisableError

      @CanIgnoreReturnValue Self addRaisableError(de.xima.bpmn_model.api.element.bpmn.common.Error error, BpmnRaisableData data)
      Adds an error that can be raised by the part, see IStructuredBpmnModelPart.raisableErrors().
      Parameters:
      error - The error to add.
      data - The data for the signal to add, such as the display name and its details.
      Returns:
      This builder, for chaining.

    • addRaisableError

      @CanIgnoreReturnValue Self addRaisableError(String errorCode, BpmnRaisableData data)
      Adds the error code of an error that can be raised by the part, see IStructuredBpmnModelPart.raisableErrors().
      Parameters:
      errorCode - The code of the error to add.
      data - The data for the signal to add, such as the display name and its details.
      Returns:
      This builder, for chaining.

    • addRaisableErrorsFromParts

      @CanIgnoreReturnValue Self addRaisableErrorsFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
      Adds all raisable errors from the given parts (usually child parts) to this part, see IStructuredBpmnModelPart.raisableErrors().
      Parameters:
      childParts - The parts to add errors from.
      Returns:
      This builder, for chaining.

    • addRaisableErrorsFromParts

      @CanIgnoreReturnValue Self addRaisableErrorsFromParts(IStructuredBpmnModelPart... childParts)
      Adds all raisable errors from the given parts (usually child parts) to this part, see IStructuredBpmnModelPart.raisableErrors().
      Parameters:
      childParts - The parts to add errors from.
      Returns:
      This builder, for chaining.

    • addRaisableEscalation

      @CanIgnoreReturnValue Self addRaisableEscalation(BpmnRaisableEscalation escalation)
      Adds the escalation code of an escalation that can be raised by the part, see IStructuredBpmnModelPart.raisableEscalations().
      Parameters:
      escalation - The escalation to add.
      Returns:
      This builder, for chaining.

    • addRaisableEscalation

      @CanIgnoreReturnValue Self addRaisableEscalation(de.xima.bpmn_model.api.element.bpmn.common.Escalation escalation, BpmnRaisableData data)
      Adds an escalation that can be raised by the part, see IStructuredBpmnModelPart.raisableEscalations().
      Parameters:
      escalation - The escalation to add.
      data - The data for the signal to add, such as the display name and its details.
      Returns:
      This builder, for chaining.

    • addRaisableEscalation

      @CanIgnoreReturnValue Self addRaisableEscalation(String escalationCode, BpmnRaisableData data)
      Adds the escalation code of an escalation that can be raised by the part, see IStructuredBpmnModelPart.raisableEscalations().
      Parameters:
      escalationCode - The code of the escalation to add.
      data - The data for the signal to add, such as the display name and its details.
      Returns:
      This builder, for chaining.

    • addRaisableEscalationsFromParts

      @CanIgnoreReturnValue Self addRaisableEscalationsFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
      Adds all raisable escalations from the given parts (usually child parts) to this part, see IStructuredBpmnModelPart.raisableEscalations().
      Parameters:
      childParts - The parts to add escalations from.
      Returns:
      This builder, for chaining.

    • addRaisableEscalationsFromParts

      @CanIgnoreReturnValue Self addRaisableEscalationsFromParts(IStructuredBpmnModelPart... childParts)
      Adds all raisable escalations from the given parts (usually child parts) to this part, see IStructuredBpmnModelPart.raisableEscalations().
      Parameters:
      childParts - The parts to add escalations from.
      Returns:
      This builder, for chaining.

    • addRaisableSignal

      @CanIgnoreReturnValue Self addRaisableSignal(BpmnRaisableSignal signal)
      Adds the signal name of a signal that can be raised by the part, see IStructuredBpmnModelPart.raisableSignals().
      Parameters:
      signal - The signal to add.
      Returns:
      This builder, for chaining.

    • addRaisableSignal

      @CanIgnoreReturnValue Self addRaisableSignal(de.xima.bpmn_model.api.element.bpmn.events.Signal signal, BpmnRaisableData data)
      Adds a signal that can be raised by the part, see IStructuredBpmnModelPart.raisableSignals().
      Parameters:
      signal - The signal to add.
      data - The data for the signal to add, such as the display name and its details.
      Returns:
      This builder, for chaining.

    • addRaisableSignal

      @CanIgnoreReturnValue Self addRaisableSignal(String signalName, BpmnRaisableData data)
      Adds the signal name of a signal that can be raised by the part, see IStructuredBpmnModelPart.raisableSignals().
      Parameters:
      signalName - The name of the signal to add.
      data - The data for the signal to add, such as the display name and its details.
      Returns:
      This builder, for chaining.

    • addRaisableSignalsFromParts

      @CanIgnoreReturnValue Self addRaisableSignalsFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
      Adds all raisable signals from the given parts (usually child parts) to this part, see IStructuredBpmnModelPart.raisableSignals() .
      Parameters:
      childParts - The parts to add signals from.
      Returns:
      This builder, for chaining.

    • addRaisableSignalsFromParts

      @CanIgnoreReturnValue Self addRaisableSignalsFromParts(IStructuredBpmnModelPart... childParts)
      Adds all raisable signals from the given parts (usually child parts) to this part, see IStructuredBpmnModelPart.raisableSignals().
      Parameters:
      childParts - The parts to add signals from.
      Returns:
      This builder, for chaining.

    • addRaisablesFromParts

      @CanIgnoreReturnValue Self addRaisablesFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
      Adds all raisable escalations, errors, and escalations from the given parts (usually child parts) to this part, see IStructuredBpmnModelPart.raisableEscalations(), IStructuredBpmnModelPart.raisableErrors(), and IStructuredBpmnModelPart.raisableSignals().
      Parameters:
      childParts - The parts to add raisables from.
      Returns:
      This builder, for chaining.

    • addRaisablesFromParts

      @CanIgnoreReturnValue Self addRaisablesFromParts(IStructuredBpmnModelPart... childParts)
      Adds all raisable escalations, errors, and escalations from the given parts (usually child parts) to this part, see raisableEscalations, raisableErrors, and raisableSignals.
      Parameters:
      childParts - The parts to add raisables from.
      Returns:
      This builder, for chaining.

    • raisableErrors

      @CanIgnoreReturnValue Self raisableErrors(Iterable<BpmnRaisableError> errors)
      Sets the errors that can be raised by the part, see IStructuredBpmnModelPart.raisableErrors().
      Returns:
      This builder, for chaining.

    • raisableEscalations

      @CanIgnoreReturnValue Self raisableEscalations(Iterable<BpmnRaisableEscalation> escalations)
      Sets the escalations that can be raised by the part, see IStructuredBpmnModelPart.raisableSignals().
      Returns:
      This builder, for chaining.

    • raisableSignals

      @CanIgnoreReturnValue Self raisableSignals(Iterable<BpmnRaisableSignal> signals)
      Sets the signals that can be raised by the part, see IStructuredBpmnModelPart.raisableSignals().
      Returns:
      This builder, for chaining.

    • removeRaisableError

      @CanIgnoreReturnValue Self removeRaisableError(String errorCode)
      Remove the error code of an error that can be raised by the part, see IStructuredBpmnModelPart.raisableErrors().
      Parameters:
      errorCode - The code of the error to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableError

      @CanIgnoreReturnValue Self removeRaisableError(BpmnRaisableError error)
      Remove the error code of an error that can be raised by the part, see IStructuredBpmnModelPart.raisableErrors().
      Parameters:
      error - An error to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableError

      @CanIgnoreReturnValue Self removeRaisableError(de.xima.bpmn_model.api.element.bpmn.common.Error error)
      Remove the error code of an error that can be raised by the part, see IStructuredBpmnModelPart.raisableErrors().
      Parameters:
      error - An error to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableErrorsFromParts

      @CanIgnoreReturnValue Self removeRaisableErrorsFromParts(IStructuredBpmnModelPart... childParts)
      Removes all raisable errors of the given parts (usually child parts) from this part, raisableErrors.
      Parameters:
      childParts - The parts with raisable errors to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableErrorsFromParts

      @CanIgnoreReturnValue Self removeRaisableErrorsFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
      Removes all raisable errors of the given parts (usually child parts) from this part, raisableErrors.
      Parameters:
      childParts - The parts with raisable errors to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableEscalation

      @CanIgnoreReturnValue Self removeRaisableEscalation(String escalationCode)
      Remove the escalation code of an escalation that can be raised by the part, see IStructuredBpmnModelPart.raisableEscalations().
      Parameters:
      escalationCode - The code of the escalation to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableEscalation

      @CanIgnoreReturnValue Self removeRaisableEscalation(BpmnRaisableEscalation escalation)
      Remove the escalation code of an escalation that can be raised by the part, see IStructuredBpmnModelPart.raisableEscalations().
      Parameters:
      escalation - An escalation to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableEscalation

      @CanIgnoreReturnValue Self removeRaisableEscalation(de.xima.bpmn_model.api.element.bpmn.common.Escalation escalation)
      Remove the escalation code of an escalation that can be raised by the part, see IStructuredBpmnModelPart.raisableEscalations().
      Parameters:
      escalation - An escalation to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableEscalationsFromParts

      @CanIgnoreReturnValue Self removeRaisableEscalationsFromParts(IStructuredBpmnModelPart... childParts)
      Removes all raisable escalations of the given parts (usually child parts) from this part, raisableEscalations.
      Parameters:
      childParts - The parts with raisable escalations to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableEscalationsFromParts

      @CanIgnoreReturnValue Self removeRaisableEscalationsFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
      Removes all raisable escalations of the given parts (usually child parts) from this part, raisableEscalations.
      Parameters:
      childParts - The parts with raisable escalations to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableEvent

      @CanIgnoreReturnValue Self removeRaisableEvent(de.xima.bpmn_model.api.behavior.EventDefinitionContaining<?> event)
      Removes all event definitions of the given the event from the raisables.
      Parameters:
      event - The event to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableEventDefinitions

      @CanIgnoreReturnValue Self removeRaisableEventDefinitions(Iterable<? extends de.xima.bpmn_model.api.element.bpmn.events.EventDefinition<?>> eventDefinitions)
      Removes all event definitions from the raisables.
      Parameters:
      eventDefinitions - The event definitions to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableEvents

      @CanIgnoreReturnValue Self removeRaisableEvents(Iterable<? extends de.xima.bpmn_model.api.behavior.EventDefinitionContaining<?>> events)
      Removes all event definitions of the given the events from the raisables.
      Parameters:
      events - The events to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableSignal

      @CanIgnoreReturnValue Self removeRaisableSignal(String signalName)
      Remove the name of a signal that can be raised by the part, see IStructuredBpmnModelPart.raisableSignals().
      Parameters:
      signalName - The name of the signal to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableSignal

      @CanIgnoreReturnValue Self removeRaisableSignal(BpmnRaisableSignal signal)
      Remove the name of a signal that can be raised by the part, see IStructuredBpmnModelPart.raisableSignals().
      Parameters:
      signal - The name of the signal to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableSignal

      @CanIgnoreReturnValue Self removeRaisableSignal(de.xima.bpmn_model.api.element.bpmn.events.Signal signal)
      Remove the name of a signal that can be raised by the part, see IStructuredBpmnModelPart.raisableSignals().
      Parameters:
      signal - The name of the signal to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableSignalsFromParts

      @CanIgnoreReturnValue Self removeRaisableSignalsFromParts(IStructuredBpmnModelPart... childParts)
      Removes all raisable signals of the given parts (usually child parts) from this part, raisableSignals.
      Parameters:
      childParts - The parts with raisable signals to remove.
      Returns:
      This builder, for chaining.

    • removeRaisableSignalsFromParts

      @CanIgnoreReturnValue Self removeRaisableSignalsFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
      Removes all raisable signals of the given parts (usually child parts) from this part, raisableSignals.
      Parameters:
      childParts - The parts with raisable signals to remove.
      Returns:
      This builder, for chaining.

    • removeRaisablesFromParts

      @CanIgnoreReturnValue Self removeRaisablesFromParts(IStructuredBpmnModelPart... childParts)
      Removes all raisable escalations, errors, and escalations of the given parts (usually child parts) from this part, see raisableEscalations, raisableErrors, and raisableSignals.
      Parameters:
      childParts - The parts which raisables to remove.
      Returns:
      This builder, for chaining.

    • removeRaisablesFromParts

      @CanIgnoreReturnValue Self removeRaisablesFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
      Removes all raisable escalations, errors, and escalations of the given parts (usually child parts) from this part, see raisableEscalations, raisableErrors, and raisableSignals.
      Parameters:
      childParts - The parts which raisables to remove.
      Returns:
      This builder, for chaining.