Package com.aquima.interactions.process.impl

Interface IEvaluationQueue

All Known Implementing Classes:
EvaluationQueue
public interface IEvaluationQueue
Interface for the queue that holds all tasks that need to be evaluated.
Since:
7.1
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addFirstTask(ITaskModel task)
    Adds the given task as the first element to the queue.
    void
    addNode(IProcessNodeDefinition node, ITaskModel parent)
    Add a node from a process to the evaluation queue.
    void
    addTask(ITaskModel task)
    Add a task to the evaluation queue, so it will be evaluated, and the process will continue from that task if needed.
    void
    cancelTask(ITaskModel task)
    This method may be invoked to cancel a task.

  • Method Details

    • addNode

      void addNode(IProcessNodeDefinition node, ITaskModel parent)
      Add a node from a process to the evaluation queue. this method should be invoked for nodes that have not yet been processed.
      Parameters:
      node - The node that should be scheduled and processed.
      parent - The parent task of the node (should never be null).
      Throws:
      AppException - This exception is thrown when the node could not be added to the queue.

    • addTask

      void addTask(ITaskModel task)
      Add a task to the evaluation queue, so it will be evaluated, and the process will continue from that task if needed.
      Parameters:
      task - The task that should be evaluated.

    • addFirstTask

      void addFirstTask(ITaskModel task)
      Adds the given task as the first element to the queue. Duplicates will be removed from the queue.
      Parameters:
      task - the task that should be evaluated.

    • cancelTask

      void cancelTask(ITaskModel task)
      This method may be invoked to cancel a task. The task will be marked as canceled, and will be removed from the queue (if needed). If the task is a process or group task, the cancelTask method will also (automatically) be invoked for any child task that has not yet been completed.
      Parameters:
      task - The task that needs to be canceled.