Package com.aquima.interactions.mapping.ds

Interface IEntityMappingDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
ReportingEntityMappingDS, XmlEntityMappingDS
public interface IEntityMappingDS extends IReportingDS
This interface defines the methods needed to initialize a mapping between two entities.
Since:
7.1
Author:
Jon van Leuven

  • Method Details

    • getTargetEntityName

      String getTargetEntityName()
      This method returns the name of the entity the values should be mapped to.
      Returns:
      the name of the entity the values should be mapped to.

    • getActionForNoMatchingTarget

      MappingAction getActionForNoMatchingTarget()
      The method returns the mapping action when no matching target instance is found.
      Returns:
      The mapping action, never null.

    • getActionForNoMatchingSource

      MappingAction getActionForNoMatchingSource()
      The method returns the mapping action when no matching source instance is found.
      Returns:
      The mapping action, never null.

    • getActionForMatch

      MappingAction getActionForMatch()
      The method returns the mapping action when a matching source and target instances is found.
      Returns:
      The mapping action, never null.

    • getCondition

      String getCondition()
      This method returns the optional precondition for this target mapping.
      Returns:
      The optional condition, may be null.

    • getSourceEntityExpression

      String getSourceEntityExpression()
      This method returns the source expression that results in instances in the source profile.
      Returns:
      The source entity expression, never null

    • getSourceContextExpressions

      String[] getSourceContextExpressions()
      This method returns the optional source expressions that can be used to activate instance(s) during value mapping evaluation.
      Returns:
      The source expression, never null, but can be an empty array.

    • iterateAttributeMappings

      void iterateAttributeMappings(IAttributeMappingVisitor visitor)
      This method will be invoked by the mapping component to request the information of all attributes mappings that are defined for this source mapping.
      Parameters:
      visitor - The visitor that should be used to add the attribute mapping definitions to.
      Throws:
      InitializationException - This exception is thrown when there is an error processing the attribte mappings.

    • iterateMatchConditions

      void iterateMatchConditions(IMatchConditionVisitor visitor)
      This method will be invoked by the mapping component to request the information of all match conditions that are defined for this source mapping.
      Parameters:
      visitor - The visitor that should be used to add the match condition definitions to.
      Throws:
      InitializationException - This exception is thrown when there is an error processing the match condition.