Interface IPromptQueryConfig_SinglePdfInput

public interface IPromptQueryConfig_SinglePdfInput
Mixin for a query connection configuration model that allows the user to configure whether the query accepts an pdf file as a file input parameter. There are three possible states: does not accept a file, accepts an optional file, or requires a file. Usually configurable via a tri-state checkbox or select widget in the user interface.

The query may also accept other files in addition to the single pdf file. It is up to implementations to define where the pdf file is stored in the list of file inputs. If the query does not allow other files, implementations are encouraged to use a file list descriptor with a single file value descriptor for the DEFAULT_FILE_KEY.

See also the <xp:singlePdfInput/> 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_SINGLE_PDF_INPUT
    The name of the single pdf input attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    SingularFileMode
    getSinglePdfInput()
    Gets whether a PDF file is allowed as a file input parameter for the prompt query.
    void
    setSinglePdfInput(SingularFileMode singlePdfInput)
    Sets whether a PDF file is allowed as a file input parameter for the prompt query.

  • Field Details

    • ATTR_SINGLE_PDF_INPUT

      static final String ATTR_SINGLE_PDF_INPUT
      The name of the single pdf input 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

    • getSinglePdfInput

      SingularFileMode getSinglePdfInput()
      Gets whether a PDF file is allowed as a file input parameter for the prompt query.
      Returns:
      Whether a single pdf input is allowed.

    • setSinglePdfInput

      void setSinglePdfInput(SingularFileMode singlePdfInput)
      Sets whether a PDF file is allowed as a file input parameter for the prompt query.
      Parameters:
      singlePdfInput - Whether a single pdf input is allowed.