BpmnRaisableError (formcycle: bom 8.4.0 API)

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

All Implemented Interfaces:

Serializable, Comparable<BpmnRaisableError>
```
public final class BpmnRaisableError
extends BpmnRaisable
implements Comparable<BpmnRaisableError>
```
Models a raisable Error in a structured BPMN model part, see also raisableErrors.
Each error is identified by its error code, 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
`BpmnRaisableError(de.xima.bpmn_model.api.element.bpmn.common.Error error, BpmnRaisableData data)`	Creates a new raisable error from the given `Error` and data.
`BpmnRaisableError(String errorCode, BpmnRaisableData data)`	Creates a new raisable error with the given error code and data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(BpmnRaisableError o)`
`boolean`	`equals(Object o)`
`String`	`errorCode()`	Gets the error code of the raisable error.
`int`	`hashCode()`

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
  - BpmnRaisableError
```
public BpmnRaisableError(String errorCode,
                         BpmnRaisableData data)
```
    Creates a new raisable error with the given error code and data.
    
    Parameters:
    
    errorCode - The error code of the error.
    
    data - The data for the raisable, such as its display name and details.
  - BpmnRaisableError
```
public BpmnRaisableError(de.xima.bpmn_model.api.element.bpmn.common.Error error,
                         BpmnRaisableData data)
```
    Creates a new raisable error from the given Error and data.
    
    Parameters:
    
    error - An error with an error code.
    
    data - The data for the raisable, such as its display name and details.
- Method Detail
  - compareTo
```
public int compareTo(BpmnRaisableError o)
```
    Specified by:
    
    compareTo in interface Comparable<BpmnRaisableError>
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in class BpmnRaisable
  - errorCode
```
public String errorCode()
```
    Gets the error code of the raisable error.
    
    Returns:
    
    The error code.
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class BpmnRaisable