Package com.aquima.interactions.portal.ds

Interface IProcessMappingDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
ReportingProcessMappingDS, XmlProcessMappingDS
public interface IProcessMappingDS extends IReportingDS
This interface is used to retrieve the information needed to be able to used a process engine.

The required information consists of:

  • Definition or link to the process engine that should be used.
  • Mapping between the model of the process engine and this application
  • Mapping for each possible task to an application and flow that should be used to execute the task.
  • Mapping between the model of the process engine and the model(s) of the applications implementing the tasks.
Since:
7.1
Author:
O. Kerpershoek

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Category
    CATEGORY
    The category used by initialization messages originating from this data-source.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getApplicationName()
    This method returns the name of the application that contains the process definitions.
    Version
    getApplicationVersion()
    This method returns the version of the application that contains the process definitions.
    String
    getCaseDataMappingName()
    This method returns the mapping information that should be used to map the model of the process engine to the model of this application.
    String
    getCaseUpdateMappingName()
    This method returns the mapping information that should be used to map the model of this application to the model of the process engine.
    void
    iterateTaskMappings(ITaskMappingVisitor visitor)
    This method will be invoked to allow the implementation to add task mapping definitions.

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

    addMessage

  • Field Details

    • CATEGORY

      static final Category CATEGORY
      The category used by initialization messages originating from this data-source.

  • Method Details

    • getApplicationName

      String getApplicationName()
      This method returns the name of the application that contains the process definitions.
      Returns:
      The name of the application that contains the process definitions.

    • getApplicationVersion

      Version getApplicationVersion()
      This method returns the version of the application that contains the process definitions.
      Returns:
      The version of the application that contains the process definitions.

    • getCaseDataMappingName

      String getCaseDataMappingName()
      This method returns the mapping information that should be used to map the model of the process engine to the model of this application.
      Returns:
      Name referring to the mapping, may be null.

    • getCaseUpdateMappingName

      String getCaseUpdateMappingName()
      This method returns the mapping information that should be used to map the model of this application to the model of the process engine.
      Returns:
      Name referring to the mapping, may be null.

    • iterateTaskMappings

      void iterateTaskMappings(ITaskMappingVisitor visitor) throws InitializationException
      This method will be invoked to allow the implementation to add task mapping definitions.
      Parameters:
      visitor - Object that should be used to add task mapping definitions to.
      Throws:
      InitializationException - This exception is thrown when the task mappings could not be initialized.