Interface ChainExecution

    • Method Detail

      • getName

        @NotNull
        @NotNull String getName()
        Gets the name of the executing Chain
        Returns:
        name
      • getPlanResultKey

        @NotNull
        @NotNull PlanResultKey getPlanResultKey()
        Get the result key
        Returns:
        resultKey
      • getStages

        @NotNull
        @NotNull List<StageExecution> getStages()
        Get Stages for this Chain
        Returns:
        stages
      • isCompleted

        boolean isCompleted()
        Returns true if the chain has finished executing
        Returns:
        false
      • isSuccessful

        boolean isSuccessful()
        Returns true if the chain has finished executing successfully
        Returns:
        success
      • isFailed

        boolean isFailed()
        Returns true if the chain execution has failed
        Returns:
        failure
      • isStopping

        boolean isStopping()
        Returns true if the chain is undergoing a 'stop' operation
        Returns:
        stopping
      • isStopRequested

        boolean isStopRequested()
        Returns true if the Chain has been requested to stop execution
        Returns:
        stopRequested
      • getExecutionContext

        @NotNull
        @NotNull ExecutionContext getExecutionContext()
        Stores contextual data for the current ChainExecution
        Returns:
        executionContext
      • getConfigObject

        @Nullable
        <T> T getConfigObject​(String key,
                              Class<T> aClass)
        Get configuration object produced by PlanConfigurationUiPlugin
        Parameters:
        key -
        aClass -
        Returns:
        configObject
        Since:
        3.0