Package org.flowable.cmmn.engine.delegate

Class CmmnFault

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.flowable.common.engine.api.FlowableException

org.flowable.common.engine.api.delegate.BusinessError

org.flowable.cmmn.engine.delegate.CmmnFault

All Implemented Interfaces:

Serializable

public class CmmnFault
extends BusinessError

Special exception that can be used to throw a CMMN Fault from PlanItemJavaDelegates, expressions, and scripts. This should only be used for business faults, which shall be handled by sentries with standardEvent="fault". Technical errors should be represented by other exception types. This is the CMMN equivalent of BPMN's BpmnError. When thrown during plan item execution, it triggers the fault transition (Active → Failed) instead of propagating as an exception.

Author:

Joram Barrez

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.flowable.common.engine.api.delegate.BusinessError

additionalDataContainer, errorCode

Fields inherited from class org.flowable.common.engine.api.FlowableException

isLogged, reduceLogLevel

Constructor Summary

Constructors

Constructor	Description
CmmnFault(String faultCode)
CmmnFault(String faultCode, String message)

Method Summary

Modifier and Type	Method	Description
void	addAdditionalData(String name, Object value)
String	getFaultCode()	Returns the fault code.

Methods inherited from class org.flowable.common.engine.api.delegate.BusinessError

getAdditionalDataContainer, getErrorCode, setAdditionalDataContainer, setErrorCode

Methods inherited from class org.flowable.common.engine.api.FlowableException

isLogged, isReduceLogLevel, setLogged, setReduceLogLevel

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CmmnFault

public CmmnFault(String faultCode)

CmmnFault

public CmmnFault(String faultCode,
 String message)

Method Details

getFaultCode

public String getFaultCode()

Returns the fault code. This is an alias for BusinessError.getErrorCode().

addAdditionalData

public void addAdditionalData(String name,
 Object value)

Specified by:

addAdditionalData in class BusinessError