Package com.aquima.interactions.flow

Interface IFlowPath

All Superinterfaces:
Serializable
All Known Implementing Classes:
FlowPath
public interface IFlowPath extends Serializable
This interface defines a path to a specific node in a flow.
Since:
5.0
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    depth()
    This method returns the depth of the flow path.
    INodeDetails
    getCurrentNode()
    This method returns the current node of the flow action, without removing it from the flow path.
    INodeDetails[]
    getNodes()
    This method returns all the nodes that have been encountered during the flow action.

  • Method Details

    • depth

      int depth()
      This method returns the depth of the flow path. The depth is equal to the number of flow nodes that is returned by the getNodes method.
      Returns:
      the depth of the flow path.

    • getNodes

      INodeDetails[] getNodes()
      This method returns all the nodes that have been encountered during the flow action.
      Returns:
      Array containing all the nodes that have been encountered during the flow action.

    • getCurrentNode

      INodeDetails getCurrentNode()
      This method returns the current node of the flow action, without removing it from the flow path.
      Returns:
      the current node of the flow action.