Package com.aquima.interactions.portal

Interface IMask

All Known Implementing Classes:
AbstractMask, AbstractSubstringMask, DatePattern, FirstToUpperCase, HexadecimalInteger, NumberPattern, OctalInteger, OrdinalNumber, RegularExpression, RomanInteger, SetCase, SpelledBoolean, SpelledCurrency, SpelledDayOfWeek, SpelledDeltaDate, SpelledInteger, SpelledMonth, SpelledNumber
public interface IMask
A mask applies formatting to an IValue and returns a multi lingual representation of the value.
Since:
6.0
Author:
Jon van Leuven

  • Method Summary

    Modifier and Type
    Method
    Description
    IMultilingualText
    apply(IPrimitiveValue fieldValue, IMaskContext context)
    Apply the mask and return a multi lingual representation of an IPrimitiveValue.

  • Method Details

    • apply

      IMultilingualText apply(IPrimitiveValue fieldValue, IMaskContext context) throws Exception
      Apply the mask and return a multi lingual representation of an IPrimitiveValue.
      Parameters:
      fieldValue - The value to be used by the mask (never null).
      context - The context in which the mask is called (never null).
      Returns:
      The applied mask result which should never be null.
      Throws:
      Exception - When an unexpected exception occurs and the mask cannot be applied.