Package de.xima.fc.prompt.service.support

Interface IPromptQueryConfig_OutputLanguage

  • public interface IPromptQueryConfig_OutputLanguage
    Mixin for a prompt query configuration model that allows the user to define the language of the output text or files that are returned by 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:outputLanguage/> 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 Detail

      • ATTR_OUTPUT_LANGUAGE

        static final String ATTR_OUTPUT_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:
        Constant Field Values

    • Method Detail

      • getOutputLanguage

        String getOutputLanguage()
        Gets the identifier of the output 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 output language identifier.

      • setOutputLanguage

        void setOutputLanguage​(String outputLanguage)
        Sets the identifier of the output 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:
        outputLanguage - The output language identifier.