Package com.aquima.interactions.portal

Interface IMaskCall

All Known Implementing Classes:
MaskCall
public interface IMaskCall
The mask call interface of which the apply can be called with an IPrimitiveValue. A mask call is a configured mask.
Since:
7.1
Author:
Jon van Leuven

  • Method Details

    • getCallName

      String getCallName()
      This method returns the mask call name.
      Returns:
      The service call name, never null.

    • getTypeName

      String getTypeName()
      This method returns the mask type name.
      Returns:
      The service type name, never null.

    • getParameters

      IParameters getParameters()
      This method returns the mask parameters.
      Returns:
      The service parameters, never null.

    • apply

      IMultilingualText apply(IPrimitiveValue primitiveValue) throws Exception
      Apply the mask call to the provided value.
      Parameters:
      primitiveValue - The value, may not be null, may be unknown.
      Returns:
      The multilingual text containing the applied mask.
      Throws:
      Exception - Is thrown when the mask could not be applied to the provided value.