Interface IWorkflowNodeResult

    • Method Detail

      • 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()
        Gets the type of how the node completed when it was executed.
        Returns:
        How the execution of the workflow node completed.
      • getFileValue

        default IWorkflowFileValue getFileValue()
        Returns:
        If isWasSuccessful() is true, this returns the files created by the node when it was executed successfully.
      • getNode

        default WorkflowNode getNode()
        Finds the workflow node that created this result.
        Returns:
        The workflow node that creates this result.
      • 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()
      • getSoftErrors

        default List<NodeSoftErrorException> getSoftErrors()
        Returns:
        If isWasSuccessful() is true, this returns the soft errors provided by the node when it was executed successfully. Returns an empty list when isWasSuccessful() is false or the node did not provide any soft errors.
        Since:
        7.0.7
      • getSuccessResultData

        @Nullable
        default ISuccessResultData getSuccessResultData()
        Returns:
        If isWasSuccessful() is true, this returns the success result data obtained by the node when it was executed successfully. Returns null when isWasSuccessful() is false.
        Since:
        7.0.7
      • getSuccessResultValue

        @Nullable
        default Object getSuccessResultValue()
        Returns:
        If isWasSuccessful() is true, this returns the result obtained by the node when it was executed successfully. Returns null when isWasSuccessful() is false or the node provided no result.
      • isAbruptlyCompleted

        default boolean isAbruptlyCompleted()
        Checks if the node completed abruptly. The difference to isWasSuccessful() is that control transfer and returning abrupt completions are considered successful.
        Returns:
        true if the node completed abruptly in any manner, false otherwise.
        Since:
        8.1.0
      • isHasSoftErrors

        default boolean isHasSoftErrors()
        Checks whether any soft errors occurred during the node's execution, i.e. whether the node completed normally or by issuing a return statements and at least one soft error was provided.
        Returns:
        Whether the node provided at least one soft error.
        Since:
        7.0.7
        See Also:
        isHasSoftOrHardErrors(), isHasHardError(), isWasSuccessful()
      • isHasSoftOrHardErrors

        default boolean isHasSoftOrHardErrors()
        Checks whether any error occurred during the node's execution, including hard and soft errors. That is, returns false when either the node completed abruptly by throwing an exception; or when the node completed normally or by issuing a return statement and at least one soft error is present.
        Returns:
        Whether any soft or hard errors occurred during the node's execution.
        Since:
        7.0.7
        See Also:
        isWasSuccessful(), isHasHardError(), isHasSoftErrors()
      • isNormallyCompleted

        default boolean isNormallyCompleted()
        Checks if the node completed normally. The difference to isWasSuccessful() is that control transfer and returning abrupt completions are considered successful.
        Returns:
        true if the node completed normally, false otherwise.
        Since:
        8.1.0