Package com.aquima.interactions.portal

Interface IMaskContext

All Known Implementing Classes:
MaskContext
public interface IMaskContext
The mask context interface defines the methods that are relevant for applying a mask.
Since:
6.0
Author:
Jon van Leuven

  • Method Details

    • getMaskTypeName

      String getMaskTypeName()
      Returns the type name of the current mask.
      Returns:
      The type name of the mask (never null).

    • getMaskCallName

      String getMaskCallName()
      Returns the name of the current mask.
      Returns:
      The name of the mask (never null).

    • getLanguages

      ILanguage[] getLanguages()
      Returns the languages that should be used for the current mask.
      Returns:
      the languages (never null)

    • getParameters

      IParameters getParameters()
      This method returns an object containing all the parameters that are defined for the current mask.
      Returns:
      Object containing the mask parameters (never null).

    • getMessage

      IMultilingualText getMessage(String key)
      This method returns a multilingual text for a specified key.
      Parameters:
      key - The key used for message lookup.
      Returns:
      The multilingual text, never null.
      Throws:
      UnknownMessageException - Is thrown when no message is available for the specified key.