BpmnRaisableData (formcycle: bom 8.4.0 API)

java.lang.Object
- de.xima.fc.common.workflow.bpmn.BpmnRaisableData

All Implemented Interfaces:

Serializable
```
public final class BpmnRaisableData
extends Object
implements Serializable
```
Additional data for a BpmnRaisable in a structured BPMN model part, see also raisableErrors, raisableEscalations, and raisableSignals. Each raisable is identifier by its identified (error code, escalation code, or signal name), but may have additional data such as a display name or details. This data can then be used e.g. by control flow elements that need to catch and rethrow events.

Since:

8.4.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`BpmnRaisableData(String displayName, String eventDisplayName, String details)`	Creates a new instance of `BpmnRaisableData` with the given display name, event display name, and details.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`details()`	Additional details about the raisable, such as a description of the error or escalation.
`String`	`displayName()`	The display name of the raisable, e.g.
`String`	`eventDisplayName()`	The display name when the event is raised via a `ThrowEvent`, e.g.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BpmnRaisableData
```
public BpmnRaisableData(String displayName,
                        String eventDisplayName,
                        String details)
```
    Creates a new instance of BpmnRaisableData with the given display name, event display name, and details.
    
    Parameters:
    
    displayName - The display name of the raisable, e.g. "loop continuation".
    
    eventDisplayName - The display name when the event is raised via a ThrowEvent, e.g. "Loop Continuation requested".
    
    details - Additional details about the raisable, such as a description of the error or escalation.
- Method Detail
  - details
```
public String details()
```
    Additional details about the raisable, such as a description of the error or escalation. For a "Loop continuation" escalation, this could be the target of the continue statement.
    null means details are desirable, but not available. An empty string means no details are needed.
    
    Returns:
    
    The details of the raisable.
  - displayName
```
public String displayName()
```
    The display name of the raisable, e.g. "loop continuation".
    
    Returns:
    
    The display name of the raisable.
  - eventDisplayName
```
public String eventDisplayName()
```
    The display name when the event is raised via a ThrowEvent, e.g. "Loop Continuation requested".
    
    Returns:
    
    The display name for the event when raised.