Package com.aquima.interactions.test.templates.flow

Class EdgeTemplate

java.lang.Object
com.aquima.interactions.test.templates.AbstractReportingTemplate
com.aquima.interactions.test.templates.flow.EdgeTemplate
public class EdgeTemplate extends AbstractReportingTemplate
This template represents an edge within the flow.
Since:
7.0
Author:
O. Kerpershoek, F. van der Meer

  • Constructor Details

    • EdgeTemplate

      protected EdgeTemplate(NodeTemplate source, com.aquima.interactions.flow.ExitEvent label, long sequenceNr)

  • Method Details

    • getId

      protected com.aquima.interactions.foundation.GUID getId()

    • getSequenceNr

      protected long getSequenceNr()

    • setTargetNode

      public NodeTemplate setTargetNode(NodeTemplate target)
      This function will set the target node this edge is connected to.
      Parameters:
      target - The target node which cannot be null.
      Returns:
      The set target node.

    • addEndNode

      public void addEndNode(String exitEvent)
      This method may be used to connect the edge to an end node of the flow. If the end node did not already exists, a new end node will be created and added to the flow.
      Parameters:
      exitEvent - The exit event of the end node.

    • addEndNode

      public void addEndNode(String exitEvent, boolean checkForSameExitEvents)
      This method may be used to connect the edge to an end node of the flow. If the end node did not already exists, a new end node will be created and added to the flow. It request the same exit events checking.
      Parameters:
      exitEvent - The exit event of the end node.
      checkForSameExitEvents - Flag for checking if the exit events are the same.

    • addEndNode

      public void addEndNode(String exitEvent, com.aquima.interactions.flow.ExitState exitState)
      This method may be used to connect the edge to an end node of the flow. If the end node did not already exists, a new end node will be created and added to the flow.
      Parameters:
      exitEvent - The exit event of the end node.
      exitState - The state of the endNode.

    • addCondition

      public ConditionNodeTemplate addCondition(String expression)
      This method will create a condition node, and connect it to the default exit event of this node.
      Parameters:
      expression - The expression of the condition node.
      Returns:
      Template representing the condition node.

    • addServiceCall

      public ServiceNodeTemplate addServiceCall(String callName)
      This method will add a service call node, and connect it to the default exit event of this node.
      Parameters:
      callName - The service call name of the node.
      Returns:
      Service node template representing the service call node.

    • addServiceCall

      public ServiceNodeTemplate addServiceCall(String serviceCallName, String serviceTypeName, com.aquima.interactions.foundation.IParameters parameters)
      This method will add a service call node, and connect it to the default exit event of this node.
      Parameters:
      serviceCallName - The call name of the service.
      serviceTypeName - The type name of the service.
      parameters - The service parameters.
      Returns:
      Service node template representing the service call node.

    • addServiceCall

      public ServiceNodeTemplate addServiceCall(String serviceCallName, String serviceTypeName, com.aquima.interactions.portal.ITypedParameters typedParameters)
      This method will add a service call node, and connect it to the default exit event of this node.
      Parameters:
      serviceCallName - The call name of the service.
      serviceTypeName - The type name of the service.
      typedParameters - The service parameters.
      Returns:
      Service node template representing the service call node.

    • addFunctionCall

      public FunctionNodeTemplate addFunctionCall(String callName, String moduleName, String flowName)
      This method will add a function call node, and connect it to the default exit event of this node.
      Parameters:
      callName - The name of the functionCall.
      moduleName - The name of the module.
      flowName - The name of the flow.
      Returns:
      Function node template representing the function call node.

    • addPage

      public PageNodeTemplate addPage(String pageName)
      This method will add a page node, and connect it to the default exit event of this node.
      Parameters:
      pageName - The name of the page.
      Returns:
      Page node template representing the page node.

    • addFlow

      public FlowNodeTemplate addFlow(String flowName)
      This method will add a (sub)flow node, and connect it to the default exit event of this node. If the name passed to this method is equal to the name of the flow it is added to, this method will NOT create a sub-flow node, but instead it will create an edge linking back to the start node of this flow. If you want to add a recursive call to this flow, use the getFlowTemplate().addFlowNode() construct.
      Parameters:
      flowName - The name of the sub-flow.
      Returns:
      Flow node node template representing the flow node, or null when the flow links back to itself.

    • getExitEvent

      public com.aquima.interactions.flow.ExitEvent getExitEvent()
      This method returns the label for this edge. The label is the exit state to which this edge is connected.
      Returns:
      The lavel of this edge.

    • getSource

      public NodeTemplate getSource()
      This method returns the node template of the node where the edge starts.
      Returns:
      the node template of the node where the edge starts.

    • getTarget

      public NodeTemplate getTarget()
      This method returns the node template of the node the edge is directed to.
      Returns:
      the node template of the node the edge is directed to.

    • toDataSource

      public com.aquima.interactions.flow.ds.IEdgeDS toDataSource()
      This method converts the template to a data source.
      Returns:
      Data source using the template definition.

    • getFlowTemplate

      public FlowTemplate getFlowTemplate()