BpmnRaisableSignal (formcycle: bom 8.4.0 API)

java.lang.Object
- de.xima.fc.common.workflow.bpmn.BpmnRaisable
- - de.xima.fc.common.workflow.bpmn.BpmnRaisableSignal

All Implemented Interfaces:

Serializable, Comparable<BpmnRaisableSignal>
```
public final class BpmnRaisableSignal
extends BpmnRaisable
implements Comparable<BpmnRaisableSignal>
```
Models a raisable Signal in a structured BPMN model part, see also raisableSignals.
Each signal is identified by its name, but may have additional data such as a display name or details, see data.

Since:

8.4.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`BpmnRaisableSignal(de.xima.bpmn_model.api.element.bpmn.events.Signal signal, BpmnRaisableData data)`	Creates a new raisable signal from the given `Signal` and data.
`BpmnRaisableSignal(String signalName, BpmnRaisableData data)`	Creates a new raisable signal with the given signal name and data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(BpmnRaisableSignal o)`
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`String`	`signalName()`	Gets the name of the raisable signal.

Methods inherited from class de.xima.fc.common.workflow.bpmn.BpmnRaisable
data

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

- Constructor Detail
  - BpmnRaisableSignal
```
public BpmnRaisableSignal(String signalName,
                          BpmnRaisableData data)
```
    Creates a new raisable signal with the given signal name and data.
    
    Parameters:
    
    signalName - The name of the signal.
    
    data - The data for the raisable, such as its display name and details.
  - BpmnRaisableSignal
```
public BpmnRaisableSignal(de.xima.bpmn_model.api.element.bpmn.events.Signal signal,
                          BpmnRaisableData data)
```
    Creates a new raisable signal from the given Signal and data.
    
    Parameters:
    
    signal - A signal with a name.
    
    data - The data for the raisable, such as its display name and details.
- Method Detail
  - compareTo
```
public int compareTo(BpmnRaisableSignal o)
```
    Specified by:
    
    compareTo in interface Comparable<BpmnRaisableSignal>
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in class BpmnRaisable
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class BpmnRaisable
  - signalName
```
public String signalName()
```
    Gets the name of the raisable signal.
    
    Returns:
    
    The name of the signal.