Interface IPromptQueryConfig_InputLanguage

public interface IPromptQueryConfig_InputLanguage
Mixin for a prompt query configuration model that allows the user to define the language of the input text or files that are passed on to the prompt. It is up to implementations which language identifiers to use and which are supported, but we recommend ISO-639-* language codes for increased interoperability.

Use of this mixin is optional, but ensures a consistent name for the property. When different prompt service handlers use the same property name, switching between different prompt service handlers preserves the configured data.

See also the <xp:inputLanguage/> Faces component from the http://www.xima.de/taglib/xfc/prompt namespace, which provides a user interface for editing the data defined by this mixin.

Since:
8.5.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ATTR_INPUT_LANGUAGE
    The name of the language attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getInputLanguage()
    Gets the identifier of the input language.
    void
    setInputLanguage(String inputLanguage)
    Sets the identifier of the input language.

  • Field Details

    • ATTR_INPUT_LANGUAGE

      static final String ATTR_INPUT_LANGUAGE
      The name of the language attribute. If you implement a custom serialization / deserialization, use this name for the attribute to increase compatibility with other prompt service handlers.
      See Also:

  • Method Details

    • getInputLanguage

      String getInputLanguage()
      Gets the identifier of the input language. It is up to implementations which language identifiers to use and which are supported, but we recommend ISO-639-* language codes for increased interoperability.
      Returns:
      The input language identifier.

    • setInputLanguage

      void setInputLanguage(String inputLanguage)
      Sets the identifier of the input language. It is up to implementations which language identifiers to use and which are supported, but we recommend ISO-639-* language codes for increased interoperability.
      Parameters:
      inputLanguage - The input language identifier.