Package com.aquima.interactions.flow.ds

Interface INodeDS

All Superinterfaces:
IReportingDS
All Known Subinterfaces:
IActionNodeDS, IEventNodeDS
All Known Implementing Classes:
ExecuteTaskNode, ReportingNodeDS, XmlActionNodeDS, XmlActionNodeDS, XmlEventNodeDS, XmlEventNodeDS, XmlNodeDS, XmlNodeDS
public interface INodeDS extends IReportingDS
This data source provides the basic information for a node in a flow.
Since:
5.0
Author:
O. Kerpershoek, F. van der Meer

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEndNodeExitEvent()
    Returns the exit event for the flow's end node.
    ExitState
    getEndNodeExitState()
    Returns the exit state for the flow's end node.
    String
    getExpression()
    When the node is a condition node, the expression should contain a condition expression.
    String
    getId()
    This method should return the unique id of the node (unique within the flow).
    String
    getPrimitiveTargetAttribute()
    This method returns the attribute that should be used to store the current value when repeating over primitive values.
    String
    getRepeatExpression()
    When the node is a flow node, the expression may contain a repeat expression.
    String
    getSortAttribute()
    This method returns the attribute that should be used to sort the values for the repeat expression.
    String
    getTargetId()
    This method should return the ID of the object the node represents.
    NodeType
    getType()
    This method should return the type of the node.
    boolean
    sortAscending()
    This method returns a boolean indicating if the repreat values should be sorted in ascending order.

    Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

    addMessage

  • Method Details

    • getId

      String getId()
      This method should return the unique id of the node (unique within the flow).
      Returns:
      String containing the id of the node.

    • getType

      NodeType getType()
      This method should return the type of the node.
      Returns:
      NodeType

    • getTargetId

      String getTargetId()
      This method should return the ID of the object the node represents. In case of an action node this method will probably return the name of a service, where as a flow node would return the name of the flow.
      Returns:
      String

    • getExpression

      String getExpression()
      When the node is a condition node, the expression should contain a condition expression.
      Returns:
      The condition expression.

    • getRepeatExpression

      String getRepeatExpression()
      When the node is a flow node, the expression may contain a repeat expression.
      Returns:
      The repeat expression, may be null.

    • getSortAttribute

      String getSortAttribute()
      This method returns the attribute that should be used to sort the values for the repeat expression. This method is only relevant when a repeat expression has been specified.
      Returns:
      the attribute that should be used to sort the instances on that where returned from the context expression.

    • sortAscending

      boolean sortAscending()
      This method returns a boolean indicating if the repreat values should be sorted in ascending order. This method is only relevant when a repeat expression has been specified.
      Returns:
      a boolean indicating if the values should be sorted in ascending order.

    • getPrimitiveTargetAttribute

      String getPrimitiveTargetAttribute()
      This method returns the attribute that should be used to store the current value when repeating over primitive values. This method is only relevant with a repeat expression resulting in primitives has been specified.
      Returns:
      the attribute that should be used to store the current value of a repeat iteration

    • getEndNodeExitState

      ExitState getEndNodeExitState()
      Returns the exit state for the flow's end node. The exit state is can be used by the flow handler to determine a rollback/commit or exception state.

      A flow has end nodes of one of the following 3 types: ok,cancel,exception.

      Returns:
      The exit state for the end node, will be null when the {getType() is not an end node type.

    • getEndNodeExitEvent

      String getEndNodeExitEvent()
      Returns the exit event for the flow's end node. The exit event is used to link this flow's end to a next edge in a parent flow.
      Returns:
      The exit event for the end node, will be null when the {getType() is not an end node type.