Package com.aquima.interactions.portal.ds

Interface ITaskMappingDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
ReportingTaskMappingDS, XmlTaskMappingDS, XmlTaskMappingDS
public interface ITaskMappingDS extends IReportingDS
This interface defines the methods that are needed to initialize a task mapping definition.
Since:
7.1
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCaseMappingName()
    This method returns the mapping information needed to map the case data to the model of the target application.
    String
    getFlowName()
    This method returns the name of the flow the task should be mapped to.
    String
    getModuleName()
    this method returns the name of the application the task should be mapped to.
    Version
    getModuleVersion()
    This method returns the version of the application the task should be mapped to.
    String
    getPrecondition()
    This method returns the precondition expression.
    String
    getResultMappingName()
    This method returns the mapping that should be used to map the model of the task back to the model of the case data.
    String
    getTaskName()
    This method returns the name of the task that should be mapped to an application flow.
    void
    iterateExitMapping(IExitMappingVisitor visitor)
    This method will be invoked to allow all the exits of the flow to be mapped to an exit of the task.

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

    addMessage

  • Method Details

    • getTaskName

      String getTaskName()
      This method returns the name of the task that should be mapped to an application flow.
      Returns:
      The name of the task that should be mapped to an application flow.

    • getModuleName

      String getModuleName()
      this method returns the name of the application the task should be mapped to.
      Returns:
      The name of the application the task should be mapped to.

    • getModuleVersion

      Version getModuleVersion()
      This method returns the version of the application the task should be mapped to.
      Returns:
      the version of the application the task should be mapped to.

    • getFlowName

      String getFlowName()
      This method returns the name of the flow the task should be mapped to.
      Returns:
      the name of the flow the task should be mapped to.

    • getCaseMappingName

      String getCaseMappingName()
      This method returns the mapping information needed to map the case data to the model of the target application. Name referring to the mapping, may be null.

    • getResultMappingName

      String getResultMappingName()
      This method returns the mapping that should be used to map the model of the task back to the model of the case data. Name referring to the mapping, may be null.

    • getPrecondition

      String getPrecondition()
      This method returns the precondition expression. If the precondition is set, the task mapping should be activated only if the expression evaluates to TRUE.
      Returns:
      The precondition expression as string.

    • iterateExitMapping

      void iterateExitMapping(IExitMappingVisitor visitor)
      This method will be invoked to allow all the exits of the flow to be mapped to an exit of the task.
      Parameters:
      visitor - The visitor that should be used to register the exits to.
      Throws:
      InitializationException - This exception is thrown when the exit mapping could not be initialized.