Interface IPromptQueryConfig_TextParameters

public interface IPromptQueryConfig_TextParameters
Mixin for a prompt query configuration model that allows the user to define a list text parameters accepted by the query. For each text parameter, the user can configure various settings, such as its PromptTextParameter.getLabel() or whether it is required. Each text parameter also has a key that identifies it.

When you use this mixin, you should also implement computeQueryInput in such a way that it set an appropriate value list descriptor as the JSON descriptor that includes text parameters. For example, you could create a record value descriptor with a property for each text parameter. If you have done that, then upon execution, a JSON value matching that descriptor must be provided, or execution will fail. The JSON value passed to the execute method by the prompt engine will conform to the descriptor you provided.

Use of this mixin is optional, but ensures a consistent name for the text parameters 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:textParameters/> 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 Details

    • ATTR_TEXT_PARAMETERS

      static final String ATTR_TEXT_PARAMETERS
      The name of the prompt text parameters 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

    • getTextParameters

      List<PromptTextParameter> getTextParameters()
      Gets the list of text parameters accepted by the prompt query.
      Returns:
      The list of text parameters.

    • setTextParameters

      void setTextParameters(List<PromptTextParameter> textParameters)
      Sets the list of text parameters accepted by the prompt query.
      Parameters:
      textParameters - The list of text parameters to set.