Class FcPromptQueryProps

java.lang.Object
de.xima.fc.workflow.taglib.model.BaseActionProps
de.xima.fc.workflow.model.nodes.FcPromptQueryProps
All Implemented Interfaces:
IDescriptionProviding, INameProviding, IPromptQueryParametersProviding, IPromptQueryProviding, IPromptQueryWithParameters, Serializable
@FcPromptQueryParameters public class FcPromptQueryProps extends BaseActionProps implements IPromptQueryWithParameters, Serializable
Model class for the database statement action (EWorkflowNodeType.FC_PROMPT_QUERY).
Since:
8.5.0
Author:
XIMA MEDIA GmbH
See Also:

  • Constructor Details

    • FcPromptQueryProps

      public FcPromptQueryProps()

  • Method Details

    • getJsonParameters

      public Object getJsonParameters()
      Description copied from interface: IPromptQueryParametersProviding
      Gets the configured JSON parameters for the prompt query. These parameters will be passed on to the prompt query upon execution.
      Specified by:
      getJsonParameters in interface IPromptQueryParametersProviding
      Returns:
      The configured single parameters for the prompt query.

    • setJsonParameters

      public void setJsonParameters(Object jsonParameters)
      Sets the configured parameters for the prompt query. These parameters will be passed on to the prompt query upon execution.
      Parameters:
      jsonParameters - The configured single parameters for the prompt query.

    • getMultiFileParameters

      public Map<String, MultiFile> getMultiFileParameters()
      Description copied from interface: IPromptQueryParametersProviding
      Gets the configured multi file parameters for the prompt query, indexed by their ID. These parameters will be passed on to the prompt query upon execution. Note that while this model class maintains a separate map for single and multi file parameters, the keys must be mutually exclusive across both maps.
      Specified by:
      getMultiFileParameters in interface IPromptQueryParametersProviding
      Returns:
      The configured multi file parameters for the prompt query.

    • setMultiFileParameters

      public void setMultiFileParameters(Map<String, MultiFile> multiFileParameters)
      Sets the configured multi file parameters for the prompt query, indexed by their ID. These parameters will be passed on to the prompt query upon execution. Note that while this model class maintains a separate map for single and multi file parameters, the keys must be mutually exclusive across all maps.
      Parameters:
      multiFileParameters - The configured multi file parameters for the prompt query.

    • getOutputFileProvision

      public FileProvision getOutputFileProvision()
      Details regarding the produces files. Applicable only if the prompt query produces files.
      Returns:
      The file provision details.

    • setOutputFileProvision

      public void setOutputFileProvision(FileProvision outputFileProvision)
      Sets the file provision details. Applicable only if the prompt query produces files.
      Parameters:
      outputFileProvision - The file provision details.

    • getPromptQuery

      public ObjectReference getPromptQuery()
      Description copied from interface: IPromptQueryProviding
      Gets the referenced prompt query. This field is required. The ObjectReference.getId() is the string representation of ContextualPromptObjectReference.
      Specified by:
      getPromptQuery in interface IPromptQueryProviding
      Returns:
      The prompt query to execute.

    • setPromptQuery

      public void setPromptQuery(ObjectReference promptQuery)
      Sets the prompt query to execute. This field is required.
      Parameters:
      promptQuery - The prompt query to execute.

    • getSingleFileParameters

      public Map<String, SingleFile> getSingleFileParameters()
      Description copied from interface: IPromptQueryParametersProviding
      Gets the configured single file parameters for the prompt query, indexed by their ID. These parameters will be passed on to the prompt query upon execution. Note that while this model class maintains a separate map for single and multi file parameters, the keys must be mutually exclusive across both maps.
      Specified by:
      getSingleFileParameters in interface IPromptQueryParametersProviding
      Returns:
      The configured single file parameters for the prompt query.

    • setSingleFileParameters

      public void setSingleFileParameters(Map<String, SingleFile> singleFileParameters)
      Sets the configured single file parameters for the prompt query, indexed by their ID. These parameters will be passed on to the prompt query upon execution. Note that while this model class maintains a separate map for single and multi file parameters, the keys must be mutually exclusive across all maps.
      Parameters:
      singleFileParameters - The configured single file parameters for the prompt query.