Class PromptFileSetParameter

java.lang.Object
de.xima.fc.prompt.service.support.PromptFileSetParameter
All Implemented Interfaces:
Serializable
public final class PromptFileSetParameter extends Object implements Serializable
A set of files for dynamic file input parameters of a prompt query. When the query is executed, the user must provide the files. This class describes the settings and constraints for these files.
Since:
8.5.0
See Also:

  • Constructor Details

    • PromptFileSetParameter

      public PromptFileSetParameter()

  • Method Details

    • getDescription

      public String getDescription()
      Gets the localized description of this set of files. Can be empty when not description is available.
      Returns:
      The localized description of this set of files.

    • setDescription

      public void setDescription(String description)
      Sets the localized description of this set of files. Can be empty when no description is available.
      Parameters:
      description - The localized description of this set of files.

    • getFileName

      public String getFileName()
      Gets the file name for the set of files. When empty, uses the original file name. Otherwise, changes the file name to this value. When the fileset contains multiple files, appends an index to the end of each file name. Should not contain an extension, always uses the extension of the original file.
      Returns:
      The file name for the set of files, or an empty string to use the original file name.

    • setFileName

      public void setFileName(String fileName)
      Sets the file name for the set of files. When empty, uses the original file name. Otherwise, changes the file name to this value. When the fileset contains multiple files, appends an index to the end of each file name. Should not contain an extension, always uses the extension of the original file.
      Parameters:
      fileName - The file name for the set of files, or an empty string to use the original file name.

    • getFileTypes

      public List<PromptFileType> getFileTypes()
      A list of allowed file types for this set of files. If empty, all file types are allowed.
      Returns:
      A list of allowed file types for this set of files, or an empty list to allow all file types.

    • setFileTypes

      public void setFileTypes(List<PromptFileType> fileTypes)
      Sets the allowed file types for this set of files. If empty, all file types are allowed.
      Parameters:
      fileTypes - A list of allowed file types for this set of files, or an empty list to allow all file types.

    • getKey

      public String getKey()
      Gets the key or ID of this parameter that uniquely identifies it.
      Returns:
      The key or ID of this parameter.

    • setKey

      public void setKey(String key)
      Sets the key or ID of this parameter that uniquely identifies it.
      Parameters:
      key - The key or ID of this parameter.

    • getLabel

      public String getLabel()
      Gets the localized label (display name) of this set of files. Can be empty when no label is available.
      Returns:
      The localized label of this set of files.

    • setLabel

      public void setLabel(String label)
      Sets the localized label (display name) of this set of files. Can be empty when no label is available.
      Parameters:
      label - The localized label of this set of files.

    • getMultiplicity

      public EPromptConfigParamFileMultiplicity getMultiplicity()
      Gets how many files can or must be provided for this set of files.
      Returns:
      The number of files that can or must be provided for this set of files.

    • setMultiplicity

      public void setMultiplicity(EPromptConfigParamFileMultiplicity multiplicity)
      Sets how many files can or must be provided for this set of files.
      Parameters:
      multiplicity - The number of files that can or must be provided for this set of files.