Package com.aquima.interactions.mapping

Interface IMappingComposer

All Known Implementing Classes:
MappingComposer
public interface IMappingComposer
This factory knows how to create elements which are usable for the mapping, such as assets.
Since:
12.3
Author:
S. Wartenberg

  • Method Summary

    Modifier and Type
    Method
    Description
    Asset
    expandAsset(String assetName, String assetFormat)
    looks up a text (asset) for the specified name and returns the expanded content.
    IMappingComposer
    forInstance(IEntityInstance instance)
    This method returns a new element composer in which the specified instance is active.
    AssetDefinition
    getAsset(String name)
    Looks up the text definition (also called an asset) for the specified name and returns the definition model.

  • Method Details

    • forInstance

      IMappingComposer forInstance(IEntityInstance instance)
      This method returns a new element composer in which the specified instance is active.
      Parameters:
      instance - The instance that should be active in the new composer.
      Returns:
      An element composer in which the provided instance is active.
      Throws:
      AppException - This exception is thrown when the instance could not be activated.

    • expandAsset

      Asset expandAsset(String assetName, String assetFormat)
      looks up a text (asset) for the specified name and returns the expanded content. In case of an unknown element an exception is thrown
      Parameters:
      assetName - The name of the text asset as defined in studio.
      assetFormat - The asset format that should be used to locate the correct text content.
      Returns:
      A asset object which is never null
      Throws:
      UnknownElementException - This exception is thrown when there is no element defined with the specified name.
      AppException - This exception is thrown when the element could not be created.

    • getAsset

      AssetDefinition getAsset(String name)
      Looks up the text definition (also called an asset) for the specified name and returns the definition model.
      Parameters:
      name - The name of the text as defined in studio.
      Returns:
      A text definition model which is never null
      Throws:
      UnknownElementException - This exception is thrown when there is no element defined with the name.
      AppException - This exception is thrown when the element could not be created