Class NodeSoftErrorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

de.xima.fc.exceptions.AbstractXfcException

de.xima.fc.exceptions.WorkflowProcessingException

de.xima.fc.exceptions.NodeSoftErrorException

All Implemented Interfaces:

com.alibaba.fastjson.serializer.JSONSerializable, de.xima.cmn.i18n.ILocalizedMessageProvider, IXfcException, IJsonLikeObject, IErrorResultData, Serializable

public final class NodeSoftErrorException
extends WorkflowProcessingException
implements IErrorResultData, IJsonLikeObject

Indicates that a soft error occurred during the execution of a workflow node. A soft error can be added when INodeHandler#execute completes normally. A soft error is similar to a warning that may indicate issues with the business logic. See ISuccessResultData#getSoftErrors for more details.

Since:

7.0.7

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
NodeSoftErrorException(IDiscriminatedUnionMember<?,?> errorMember, String message)	Deprecated. Use NodeSoftErrorException(String, Object, String) instead.
NodeSoftErrorException(IDiscriminatedUnionMember<?,?> errorMember, String message, Throwable cause)	Deprecated. Use NodeSoftErrorException(String, Object, String, Throwable) instead.
NodeSoftErrorException(IDiscriminatedUnionMember<?,?> errorMember, Throwable cause)	Deprecated. Use NodeSoftErrorException(String, Object, Throwable) instead.
NodeSoftErrorException(String errorCode, Object errorValue, String message)	Creates a new exception with the given data for a soft error that occurred during execution of a node.
NodeSoftErrorException(String errorCode, Object errorValue, String message, Throwable cause)	Creates a new exception with the given data for a soft error that occurred during execution of a node.
NodeSoftErrorException(String errorCode, Object errorValue, Throwable cause)	Creates a new exception with the given data for a soft error that occurred during execution of a node.

Method Summary

Modifier and Type	Method	Description
Collection<String>	getPropertyKeys()
Object	getValueAtKey(String key)
Object	getWorkflowExceptionData()
String	getWorkflowExceptionType()
String	toString()

Methods inherited from class WorkflowProcessingException

getDefaultErrorCode, getDefaultMessageKey

Methods inherited from class AbstractXfcException

getErrorCode, getExceptionData, getLocalizedMessage, getMessageKey, getMessageParams

Methods inherited from class Throwable

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

Methods inherited from class Object

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

Methods inherited from interface IErrorResultData

getCause, getMessage

Methods inherited from interface IJsonLikeObject

write

Constructor Details

NodeSoftErrorException

@Deprecated
public NodeSoftErrorException(IDiscriminatedUnionMember<?,?> errorMember,
 String message)

Deprecated.

Use NodeSoftErrorException(String, Object, String) instead.

Creates a new exception with the given data for a soft error that occurred during execution of a node.

Parameters:

errorMember - Data made available by the node when the soft error occurs.

message - Error message describing the error that occurred.

NodeSoftErrorException

@Deprecated
public NodeSoftErrorException(IDiscriminatedUnionMember<?,?> errorMember,
 String message,
 Throwable cause)

Deprecated.

Use NodeSoftErrorException(String, Object, String, Throwable) instead.

Creates a new exception with the given data for a soft error that occurred during execution of a node.

Parameters:

errorMember - Data made available by the node when the soft error occurs.

message - Error message describing the error that occurred.

cause - Cause that resulted in this exception.

NodeSoftErrorException

@Deprecated
public NodeSoftErrorException(IDiscriminatedUnionMember<?,?> errorMember,
 Throwable cause)

Deprecated.

Use NodeSoftErrorException(String, Object, Throwable) instead.

Creates a new exception with the given data for a soft error that occurred during execution of a node.

Parameters:

errorMember - Data made available by the node when the soft error occurs.

cause - Cause that resulted in this exception.

NodeSoftErrorException

public NodeSoftErrorException(String errorCode,
 Object errorValue,
 String message)

Creates a new exception with the given data for a soft error that occurred during execution of a node.

Parameters:

errorCode - Error code raised by the node when the soft error occurs.

errorValue - Data made available by the node when the soft error occurs.

message - Error message describing the error that occurred.

Since:

8.5.0

NodeSoftErrorException

public NodeSoftErrorException(String errorCode,
 Object errorValue,
 String message,
 Throwable cause)

Creates a new exception with the given data for a soft error that occurred during execution of a node.

Parameters:

errorCode - Error code raised by the node when the soft error occurs.

errorValue - Data made available by the node when the soft error occurs.

message - Error message describing the error that occurred.

cause - Cause that resulted in this exception.

Since:

8.5.0

NodeSoftErrorException

public NodeSoftErrorException(String errorCode,
 Object errorValue,
 Throwable cause)

Creates a new exception with the given data for a soft error that occurred during execution of a node.

Parameters:

errorCode - Error code raised by the node when the soft error occurs.

errorValue - Data made available by the node when the soft error occurs.

cause - Cause that resulted in this exception.

Since:

8.5.0

Method Details

getPropertyKeys

public Collection<String> getPropertyKeys()

Specified by:

getPropertyKeys in interface IJsonLikeObject

Returns:

All keys available on the object.

getValueAtKey

public Object getValueAtKey(String key)

Specified by:

getValueAtKey in interface IJsonLikeObject

Parameters:

key - One of the keys returned by IJsonLikeObject.getPropertyKeys().

Returns:

The value at the given key.

getWorkflowExceptionData

public Object getWorkflowExceptionData()

Specified by:

getWorkflowExceptionData in interface IErrorResultData

Returns:

Custom data for the exception type that contain further details on the error. May be null in case no data is available.

getWorkflowExceptionType

public String getWorkflowExceptionType()

Specified by:

getWorkflowExceptionType in interface IErrorResultData

Returns:

Describes the type of error that occurred during the execution of a workflow node. Empty string for a general error that cannot be classified further.

toString

public String toString()

Overrides:

toString in class Throwable