Interface IEventContainingStructuredBpmnModelPartBuilder<Self>
-
- Type Parameters:
Self
- The type of the builder.
- All Known Subinterfaces:
IStructuredBpmnModelPartBuilder<Self>
,IWorkflowNodeBpmnModelPartBuilder
,IWorkflowProcessBpmnModelPartBuilder
,IWorkflowTaskBpmnModelPartBuilder
,IWorkflowTriggerBpmnModelPartBuilder
public interface IEventContainingStructuredBpmnModelPartBuilder<Self>
AIStructuredBpmnModelPartBuilder
for parts that can containevents
. Allows the events that can be raised to be declared.- Since:
- 8.4.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Self
addRaisableError(de.xima.bpmn_model.api.element.bpmn.common.Error error, BpmnRaisableData data)
Adds an error that can be raised by the part, seeIStructuredBpmnModelPart.raisableErrors()
.Self
addRaisableError(BpmnRaisableError error)
Adds theerror code
of an error that can be raised by the part, seeIStructuredBpmnModelPart.raisableErrors()
.Self
addRaisableError(String errorCode, BpmnRaisableData data)
Adds theerror code
of an error that can be raised by the part, seeIStructuredBpmnModelPart.raisableErrors()
.Self
addRaisableErrorsFromParts(IStructuredBpmnModelPart... childParts)
Adds all raisable errors from the given parts (usually child parts) to this part, seeIStructuredBpmnModelPart.raisableErrors()
.Self
addRaisableErrorsFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
Adds all raisable errors from the given parts (usually child parts) to this part, seeIStructuredBpmnModelPart.raisableErrors()
.Self
addRaisableEscalation(de.xima.bpmn_model.api.element.bpmn.common.Escalation escalation, BpmnRaisableData data)
Adds an escalation that can be raised by the part, seeIStructuredBpmnModelPart.raisableEscalations()
.Self
addRaisableEscalation(BpmnRaisableEscalation escalation)
Adds theescalation code
of an escalation that can be raised by the part, seeIStructuredBpmnModelPart.raisableEscalations()
.Self
addRaisableEscalation(String escalationCode, BpmnRaisableData data)
Adds theescalation code
of an escalation that can be raised by the part, seeIStructuredBpmnModelPart.raisableEscalations()
.Self
addRaisableEscalationsFromParts(IStructuredBpmnModelPart... childParts)
Adds all raisable escalations from the given parts (usually child parts) to this part, seeIStructuredBpmnModelPart.raisableEscalations()
.Self
addRaisableEscalationsFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
Adds all raisable escalations from the given parts (usually child parts) to this part, seeIStructuredBpmnModelPart.raisableEscalations()
.Self
addRaisablesFromParts(IStructuredBpmnModelPart... childParts)
Adds all raisable escalations, errors, and escalations from the given parts (usually child parts) to this part, seeraisableEscalations
,raisableErrors
, andraisableSignals
.Self
addRaisablesFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
Adds all raisable escalations, errors, and escalations from the given parts (usually child parts) to this part, seeIStructuredBpmnModelPart.raisableEscalations()
,IStructuredBpmnModelPart.raisableErrors()
, andIStructuredBpmnModelPart.raisableSignals()
.Self
addRaisableSignal(de.xima.bpmn_model.api.element.bpmn.events.Signal signal, BpmnRaisableData data)
Adds a signal that can be raised by the part, seeIStructuredBpmnModelPart.raisableSignals()
.Self
addRaisableSignal(BpmnRaisableSignal signal)
Adds thesignal name
of a signal that can be raised by the part, seeIStructuredBpmnModelPart.raisableSignals()
.Self
addRaisableSignal(String signalName, BpmnRaisableData data)
Adds thesignal name
of a signal that can be raised by the part, seeIStructuredBpmnModelPart.raisableSignals()
.Self
addRaisableSignalsFromParts(IStructuredBpmnModelPart... childParts)
Adds all raisable signals from the given parts (usually child parts) to this part, seeIStructuredBpmnModelPart.raisableSignals()
.Self
addRaisableSignalsFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
Adds all raisable signals from the given parts (usually child parts) to this part, seeIStructuredBpmnModelPart.raisableSignals()
.Self
raisableErrors(Iterable<BpmnRaisableError> errors)
Sets theerrors
that can be raised by the part, seeIStructuredBpmnModelPart.raisableErrors()
.Self
raisableEscalations(Iterable<BpmnRaisableEscalation> escalations)
Sets theescalations
that can be raised by the part, seeIStructuredBpmnModelPart.raisableSignals()
.Self
raisableSignals(Iterable<BpmnRaisableSignal> signals)
Sets thesignals
that can be raised by the part, seeIStructuredBpmnModelPart.raisableSignals()
.Self
removeRaisableError(de.xima.bpmn_model.api.element.bpmn.common.Error error)
Remove theerror code
of an error that can be raised by the part, seeIStructuredBpmnModelPart.raisableErrors()
.Self
removeRaisableError(BpmnRaisableError error)
Remove theerror code
of an error that can be raised by the part, seeIStructuredBpmnModelPart.raisableErrors()
.Self
removeRaisableError(String errorCode)
Remove theerror code
of an error that can be raised by the part, seeIStructuredBpmnModelPart.raisableErrors()
.Self
removeRaisableErrorsFromParts(IStructuredBpmnModelPart... childParts)
Removes all raisable errors of the given parts (usually child parts) from this part,raisableErrors
.Self
removeRaisableErrorsFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
Removes all raisable errors of the given parts (usually child parts) from this part,raisableErrors
.Self
removeRaisableEscalation(de.xima.bpmn_model.api.element.bpmn.common.Escalation escalation)
Remove theescalation code
of an escalation that can be raised by the part, seeIStructuredBpmnModelPart.raisableEscalations()
.Self
removeRaisableEscalation(BpmnRaisableEscalation escalation)
Remove theescalation code
of an escalation that can be raised by the part, seeIStructuredBpmnModelPart.raisableEscalations()
.Self
removeRaisableEscalation(String escalationCode)
Remove theescalation code
of an escalation that can be raised by the part, seeIStructuredBpmnModelPart.raisableEscalations()
.Self
removeRaisableEscalationsFromParts(IStructuredBpmnModelPart... childParts)
Removes all raisable escalations of the given parts (usually child parts) from this part,raisableEscalations
.Self
removeRaisableEscalationsFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
Removes all raisable escalations of the given parts (usually child parts) from this part,raisableEscalations
.Self
removeRaisableEvent(de.xima.bpmn_model.api.behavior.EventDefinitionContaining<?> event)
Removes allevent definitions
of the given the event from the raisables.Self
removeRaisableEventDefinitions(Iterable<? extends de.xima.bpmn_model.api.element.bpmn.events.EventDefinition<?>> eventDefinitions)
Removes allevent definitions
from the raisables.Self
removeRaisableEvents(Iterable<? extends de.xima.bpmn_model.api.behavior.EventDefinitionContaining<?>> events)
Removes allevent definitions
of the given the events from the raisables.Self
removeRaisablesFromParts(IStructuredBpmnModelPart... childParts)
Removes all raisable escalations, errors, and escalations of the given parts (usually child parts) from this part, seeraisableEscalations
,raisableErrors
, andraisableSignals
.Self
removeRaisablesFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
Removes all raisable escalations, errors, and escalations of the given parts (usually child parts) from this part, seeraisableEscalations
,raisableErrors
, andraisableSignals
.Self
removeRaisableSignal(de.xima.bpmn_model.api.element.bpmn.events.Signal signal)
Remove thename
of a signal that can be raised by the part, seeIStructuredBpmnModelPart.raisableSignals()
.Self
removeRaisableSignal(BpmnRaisableSignal signal)
Remove thename
of a signal that can be raised by the part, seeIStructuredBpmnModelPart.raisableSignals()
.Self
removeRaisableSignal(String signalName)
Remove thename
of a signal that can be raised by the part, seeIStructuredBpmnModelPart.raisableSignals()
.Self
removeRaisableSignalsFromParts(IStructuredBpmnModelPart... childParts)
Removes all raisable signals of the given parts (usually child parts) from this part,raisableSignals
.Self
removeRaisableSignalsFromParts(Iterable<? extends IStructuredBpmnModelPart> childParts)
Removes all raisable signals of the given parts (usually child parts) from this part,raisableSignals
.
-
-
-
Method Detail
-
addRaisableError
@CanIgnoreReturnValue Self addRaisableError(BpmnRaisableError error)
Adds theerror code
of an error that can be raised by the part, seeIStructuredBpmnModelPart.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, seeIStructuredBpmnModelPart.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 theerror code
of an error that can be raised by the part, seeIStructuredBpmnModelPart.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, seeIStructuredBpmnModelPart.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, seeIStructuredBpmnModelPart.raisableErrors()
.- Parameters:
childParts
- The parts to add errors from.- Returns:
- This builder, for chaining.
-
addRaisableEscalation
@CanIgnoreReturnValue Self addRaisableEscalation(BpmnRaisableEscalation escalation)
Adds theescalation code
of an escalation that can be raised by the part, seeIStructuredBpmnModelPart.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, seeIStructuredBpmnModelPart.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 theescalation code
of an escalation that can be raised by the part, seeIStructuredBpmnModelPart.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, seeIStructuredBpmnModelPart.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, seeIStructuredBpmnModelPart.raisableEscalations()
.- Parameters:
childParts
- The parts to add escalations from.- Returns:
- This builder, for chaining.
-
addRaisableSignal
@CanIgnoreReturnValue Self addRaisableSignal(BpmnRaisableSignal signal)
Adds thesignal name
of a signal that can be raised by the part, seeIStructuredBpmnModelPart.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, seeIStructuredBpmnModelPart.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 thesignal name
of a signal that can be raised by the part, seeIStructuredBpmnModelPart.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, seeIStructuredBpmnModelPart.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, seeIStructuredBpmnModelPart.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, seeIStructuredBpmnModelPart.raisableEscalations()
,IStructuredBpmnModelPart.raisableErrors()
, andIStructuredBpmnModelPart.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, seeraisableEscalations
,raisableErrors
, andraisableSignals
.- Parameters:
childParts
- The parts to add raisables from.- Returns:
- This builder, for chaining.
-
raisableErrors
@CanIgnoreReturnValue Self raisableErrors(Iterable<BpmnRaisableError> errors)
Sets theerrors
that can be raised by the part, seeIStructuredBpmnModelPart.raisableErrors()
.- Returns:
- This builder, for chaining.
-
raisableEscalations
@CanIgnoreReturnValue Self raisableEscalations(Iterable<BpmnRaisableEscalation> escalations)
Sets theescalations
that can be raised by the part, seeIStructuredBpmnModelPart.raisableSignals()
.- Returns:
- This builder, for chaining.
-
raisableSignals
@CanIgnoreReturnValue Self raisableSignals(Iterable<BpmnRaisableSignal> signals)
Sets thesignals
that can be raised by the part, seeIStructuredBpmnModelPart.raisableSignals()
.- Returns:
- This builder, for chaining.
-
removeRaisableError
@CanIgnoreReturnValue Self removeRaisableError(String errorCode)
Remove theerror code
of an error that can be raised by the part, seeIStructuredBpmnModelPart.raisableErrors()
.- Parameters:
errorCode
- The code of the error to remove.- Returns:
- This builder, for chaining.
-
removeRaisableError
@CanIgnoreReturnValue Self removeRaisableError(BpmnRaisableError error)
Remove theerror code
of an error that can be raised by the part, seeIStructuredBpmnModelPart.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 theerror code
of an error that can be raised by the part, seeIStructuredBpmnModelPart.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 theescalation code
of an escalation that can be raised by the part, seeIStructuredBpmnModelPart.raisableEscalations()
.- Parameters:
escalationCode
- The code of the escalation to remove.- Returns:
- This builder, for chaining.
-
removeRaisableEscalation
@CanIgnoreReturnValue Self removeRaisableEscalation(BpmnRaisableEscalation escalation)
Remove theescalation code
of an escalation that can be raised by the part, seeIStructuredBpmnModelPart.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 theescalation code
of an escalation that can be raised by the part, seeIStructuredBpmnModelPart.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 allevent 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 allevent 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 allevent 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 thename
of a signal that can be raised by the part, seeIStructuredBpmnModelPart.raisableSignals()
.- Parameters:
signalName
- The name of the signal to remove.- Returns:
- This builder, for chaining.
-
removeRaisableSignal
@CanIgnoreReturnValue Self removeRaisableSignal(BpmnRaisableSignal signal)
Remove thename
of a signal that can be raised by the part, seeIStructuredBpmnModelPart.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 thename
of a signal that can be raised by the part, seeIStructuredBpmnModelPart.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, seeraisableEscalations
,raisableErrors
, andraisableSignals
.- 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, seeraisableEscalations
,raisableErrors
, andraisableSignals
.- Parameters:
childParts
- The parts which raisables to remove.- Returns:
- This builder, for chaining.
-
-