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

Interface IPromptQueryConfig_SingleVideoInput

  • public interface IPromptQueryConfig_SingleVideoInput
    Mixin for a query connection configuration model that allows the user to configure whether the query accepts an video 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 video file. It is up to implementations to define where the video 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:singleVideoInput/> 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_SINGLE_VIDEO_INPUT

        static final String ATTR_SINGLE_VIDEO_INPUT
        The name of the single video 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:
        Constant Field Values

    • Method Detail

      • getSingleVideoInput

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

      • setSingleVideoInput

        void setSingleVideoInput​(SingularFileMode singleVideoInput)
        Sets whether a video file is allowed as a file input parameter for the prompt query.
        Parameters:
        singleVideoInput - Whether a single video input is allowed.