Interface IWorkflowNodeResult
-
- All Known Implementing Classes:
WorkflowNodeResult
public interface IWorkflowNodeResult
Represents the result obtained when a workflow node was executed. The execution may have- completed normally, in which case
getNormalCompletionResult()
is available - completed abruptly by throwing an exception, in which case
getAbruptCompletionException()
is available and returns aNodeThrewException
. - completed abruptly by requesting a return, in which case
getAbruptCompletionException()
is available and returns aNodeReturnedException
.
- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description AbstractAbruptCompletionException
getAbruptCompletionException()
default Object
getAlwaysResultValue()
ENodeCompletionType
getCompletionType()
default IWorkflowFileValue
getFileValue()
INormalCompletionResult
getNormalCompletionResult()
default NodeReturnedException
getReturningException()
default Object
getSuccessResultValue()
default NodeThrewException
getThrowingException()
default boolean
isWasSuccessful()
Checks whether the node was executed successfully, i.e. whether it completed normally or by requesting a return.
-
-
-
Method Detail
-
getAbruptCompletionException
@Nullable AbstractAbruptCompletionException getAbruptCompletionException()
- Returns:
- The exception that was thrown by the workflow node, or
null
when the node did not complete abruptly. - See Also:
getCompletionType()
-
getAlwaysResultValue
default Object getAlwaysResultValue()
- Returns:
- The value of the result that is always available. May be
null
if the node provides no result.
-
getCompletionType
ENodeCompletionType getCompletionType()
- Returns:
- How the execution of the workflow node completed.
-
getFileValue
default IWorkflowFileValue getFileValue()
- Returns:
- If
isWasSuccessful()
istrue
, this returns the files created by the node when it was executed successfully.
-
getNormalCompletionResult
@Nullable INormalCompletionResult getNormalCompletionResult()
- Returns:
- The result returned by the workflow node upon execution, or
null
when the node did not complete normally. - See Also:
getCompletionType()
-
getReturningException
@Nullable default NodeReturnedException getReturningException()
- Returns:
- The
NodeReturnedException
whengetCompletionType()
isENodeCompletionType.RETURNING
, ornull
otherwise.
-
getSuccessResultValue
@Nullable default Object getSuccessResultValue()
- Returns:
- If
isWasSuccessful()
istrue
, this returns the result obtained by the node when it was executed successfully. Returnsnull
when IfisWasSuccessful()
isfalse
or the node provided no result.
-
getThrowingException
@Nullable default NodeThrewException getThrowingException()
- Returns:
- The
NodeThrewException
whengetCompletionType()
isENodeCompletionType.THROWING
, ornull
otherwise.
-
isWasSuccessful
default boolean isWasSuccessful()
Checks whether the node was executed successfully, i.e. whether it completed normally or by requesting a return. When this returnstrue
,getSuccessResultValue()
is available.- Returns:
- Whether the node was executed successfully.
-
-