Package com.aquima.interactions.flow.ds

Interface IFlowDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
FlowDS, ReportingFlowDS, XmlFlowDS, XmlFlowDS
public interface IFlowDS extends IReportingDS
This data source provides all the information to initialize a single flow.
Since:
5.0
Author:
O. Kerpershoek, F. van der Meer

  • Method Details

    • getName

      String getName()
      This method returns the (unique) name of the flow.
      Returns:
      The name of the flow.

    • isExposed

      boolean isExposed()
      This method returns a boolean indicating if the flow may be accessed externally.
      Returns:
      a boolean indicating if the flow may be accessed externally.

    • iterateParameters

      void iterateParameters(IFlowParameterVisitor visitor)
      Optional method that may be used to pass additional parameters to the NodeFactory. This method should be used in conjunction with the NodeFactory, as the optional parameters will be ignored by the default implementation.
      Parameters:
      visitor - the visitor which accepts the parameter information

    • getStartNodeId

      String getStartNodeId()
      This method returns the ID of the start node.
      Returns:
      The ID of the start node.

    • getFlowTypeName

      String getFlowTypeName()
      This method returns the (optional) type name of the flow.
      Returns:
      The type name of the flow, may be null.

    • iterateNodes

      void iterateNodes(INodeVisitor nodeVisitor)
      This method traverses all nodes for flow.
      Parameters:
      nodeVisitor - the visitor which accepts the node information
      Throws:
      InitializationException - This exception is thrown when the nodes could not be initialized.

    • iterateEdges

      void iterateEdges(IEdgeVisitor edgeVisitor)
      This method traverses all edges for this node pointing to the next node.
      Parameters:
      edgeVisitor - the visitor which accepts the edge information
      Throws:
      InitializationException - This exception is thrown when some of the edges could not be accepted due to a fatal error.

    • getFunctionFlowDefinition

      IFunctionFlowDefinitionDS getFunctionFlowDefinition()
      This method returns the definition of the function flow.
      Returns:
      The function flow definition, may be null.

    • getExternalFlowDefinition

      IExternalFlowDefinitionDS getExternalFlowDefinition()
      This method returns the definition of the external flow.
      Returns:
      The external flow definition, may be null.

    • getDcmWidgetFlowDefinition

      IDcmWidgetFlowDefinitionDS getDcmWidgetFlowDefinition()
      This method returns the definition of the DCM widget flow.
      Returns:
      The DCM widget flow definition, may be null.