Package com.aquima.interactions.process.ds

Interface IProcessNodeDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
XmlProcessNodeDS, XmlProcessNodeDS
public interface IProcessNodeDS extends IReportingDS
This data source is used during initialization to retrieve the information of a single node from a process definition.
Since:
7.0
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCondition()
    This method returns the condition that should be met in order for the task to be scheduled.
    ProcessExit
    getExitState()
    This method returns the name of the exit state of this node.
    GUID
    getId()
    This method should return the unique id of the node.
    IIntermediateMessageEventMappingDS
    getMessageEventMapping()
    This method returns the message event this node should wait for.
    String
    getProcessName()
    This method returns the name of the (sub) process this node represents.
    ReevaluationEvent
    getReevaluationEvent()
    This method returns the reevaluation event, which determines when a timer expression needs to be updated.
    String
    getRequiredCondition()
    This method returns a boolean expression indicating if the ad-hoc task or process should be removed as soon as the condition no longer evaluates to true.
    String
    getTaskName()
    This method returns the name of the task this node represents.
    String
    getTimerExpression()
    This method returns the expression that should be evaluated to determine the wait time.
    ProcessNodeType
    getType()
    This method returns the type of the node.
    boolean
    isAdHocTask()
    This method returns a boolean indicating if the node is an ad-hoc task or process.
    boolean
    isRepeatable()
    This method returns a boolean indicating if the task may be repeated once it has been completed.
    boolean
    locksCase()
    This method returns if the case should be locked when the task is started.

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

    addMessage

  • Method Details

    • getId

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

    • getType

      ProcessNodeType getType()
      This method returns the type of the node.
      Returns:
      The type of the node.

    • isAdHocTask

      boolean isAdHocTask()
      This method returns a boolean indicating if the node is an ad-hoc task or process. Only nodes of the type task, process, event, timer and condition may return true here. Nodes that indicate to be ad-hoc may not be used in the main process flow.
      Returns:
      boolean indicating if the node is an ad-hoc task or process.

    • getRequiredCondition

      String getRequiredCondition()
      This method returns a boolean expression indicating if the ad-hoc task or process should be removed as soon as the condition no longer evaluates to true. An ad-hoc process that indicates to be volatile may only contain ad-hoc tasks, and not a normal flow.
      Returns:
      Boolean expression indicating if the ad-hoc task should be removed once the condition is no longer true.

    • getCondition

      String getCondition()
      This method returns the condition that should be met in order for the task to be scheduled. The condition is only relevant when the task is used as an ad-hoc task in a process.
      Returns:
      The condition that should be met in order for the task to be scheduled.

    • getTimerExpression

      String getTimerExpression()
      This method returns the expression that should be evaluated to determine the wait time. The timer expression is only relevant for wait nodes.
      Returns:
      the expression that should be evaluated to determine the wait time.

    • getReevaluationEvent

      ReevaluationEvent getReevaluationEvent()
      This method returns the reevaluation event, which determines when a timer expression needs to be updated.
      Returns:
      the reevaluation event

    • getTaskName

      String getTaskName()
      This method returns the name of the task this node represents. The task name is only relevant for task nodes.
      Returns:
      the name of the task this node represents.

    • getProcessName

      String getProcessName()
      This method returns the name of the (sub) process this node represents. The process name is only relevant for process nodes.
      Returns:
      the name of the (sub) process this node represents.

    • getExitState

      ProcessExit getExitState()
      This method returns the name of the exit state of this node. The exit state is only relevant for end nodes.
      Returns:
      the name of the exit state of this node.

    • locksCase

      boolean locksCase()
      This method returns if the case should be locked when the task is started. The locksCase flag is only relevant for task nodes.
      Returns:
      the lock case flag of the task this node represents.

    • getMessageEventMapping

      IIntermediateMessageEventMappingDS getMessageEventMapping()
      This method returns the message event this node should wait for. The name of the event is only relevant for event nodes.
      Returns:
      The mapping for the message event.

    • isRepeatable

      boolean isRepeatable()
      This method returns a boolean indicating if the task may be repeated once it has been completed. Note: Only ad-hoc nodes can be repeatable, except for an ad hoc condition nodes.
      Returns:
      a boolean indicating if the task may be repeated once it has been completed.