Interface StepObserver

  • All Known Subinterfaces:
    UI
    All Known Implementing Classes:
    BasicUI, LanternaUI, NoUI

    public interface StepObserver
    This interface define workflow step events
    Since:
    2.0
    Author:
    Laurent Jourdren
    • Method Detail

      • notifyStepState

        void notifyStepState​(Step step,
                             Step.StepState stepState)
        The status of the step has been changed.
        Parameters:
        step - step that the status has been changed
        stepState - state the step state
      • notifyStepState

        void notifyStepState​(Step step,
                             int contextId,
                             String contextName,
                             double progress)
        The progress of the step for a sample has been changed.
        Parameters:
        step - step that the progress has been changed
        contextId - id of the context
        contextName - name of the context that has been changed
      • notifyStepState

        void notifyStepState​(Step step,
                             int terminatedTasks,
                             int submittedTasks,
                             double progress)
        The progress of the step has been changed.
        Parameters:
        step - step that the progress has been changed
        terminatedTasks - the terminated tasks count
        submittedTasks - the submitted tasks count
        progress - the progress of the step
      • notifyStepState

        void notifyStepState​(Step step,
                             String note)
        The note of the step has been changed.
        Parameters:
        step - step that the note has been changed
      • notifyTaskSubmitted

        void notifyTaskSubmitted​(Step step,
                                 int contextId)
        Notify that a task has been submitted.
        Parameters:
        step - the step of the submitted task
        contextId - id of the context
      • notifyTaskRunning

        void notifyTaskRunning​(Step step,
                               int contextId)
        Notify that a task is running.
        Parameters:
        step - the step of the submitted task
        contextId - id of the context
      • notifyTaskDone

        void notifyTaskDone​(Step step,
                            int contextId)
        Notify that a task has been done.
        Parameters:
        step - the step of the submitted task
        contextId - id of the context
      • notifyWorkflowSuccess

        void notifyWorkflowSuccess​(boolean success,
                                   String message)
        Notify the success of the workflow.
        Parameters:
        success - the success of the workflow
        message - success message