Package de.xima.fc.workflow.processor.factory

Interface IPromptQueryBuilder

All Superinterfaces:

IBaseActionPropsBuilder<IPromptQueryBuilder,FcPromptQueryProps>, IWorkflowElementBuilder<WorkflowNode,FcPromptQueryProps>

public interface IPromptQueryBuilder
extends IBaseActionPropsBuilder<IPromptQueryBuilder,FcPromptQueryProps>

Builder for configuring a EWorkflowNodeType.FC_PROMPT_QUERY action.

Since:

8.5.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IPromptQueryBuilder	addMultiFileParameter(String key, MultiFile value)	Adds a multi file parameter to be passed to the prompt query upon execution.
IPromptQueryBuilder	addSingleFileParameter(String key, SingleFile value)	Adds a single file parameter to be passed to the prompt query upon execution.
IPromptQueryBuilder	jsonParameters(Object value)	Sets the JSON parameters value to be passed to the prompt query upon execution.
IPromptQueryBuilder	multiFileParameters(Map<String,MultiFile> multiFileParameters)	Sets the multi file parameters to be passed to the prompt query upon execution.
IPromptQueryBuilder	outputFileProvision(FileProvision outputFileProvision)	Sets the output file provision configuration for the prompt query action.
IPromptQueryBuilder	promptQuery(ObjectReference promptQuery)	Sets the prompt query to be executed by the action.
IPromptQueryBuilder	singleFileParameters(Map<String,SingleFile> singleFileParameters)	Sets the single file parameters to be passed to the prompt query upon execution.

Methods inherited from interface de.xima.fc.workflow.processor.factory.IBaseActionPropsBuilder

color, description, icon, name

Methods inherited from interface de.xima.fc.workflow.processor.factory.IWorkflowElementBuilder

build, buildProps

Method Detail

addMultiFileParameter

IPromptQueryBuilder addMultiFileParameter(String key,
                                          MultiFile value)

Adds a multi file parameter to be passed to the prompt query upon execution.

Parameters:

key - The parameter key.

value - The parameter value.

Returns:

This builder for chaining methods calls.

addSingleFileParameter

IPromptQueryBuilder addSingleFileParameter(String key,
                                           SingleFile value)

Adds a single file parameter to be passed to the prompt query upon execution.

Parameters:

key - The parameter key.

value - The parameter value.

Returns:

This builder for chaining methods calls.

jsonParameters

IPromptQueryBuilder jsonParameters(Object value)

Sets the JSON parameters value to be passed to the prompt query upon execution.

Parameters:

value - The JSON parameters value.

Returns:

This builder for chaining methods calls.

multiFileParameters

IPromptQueryBuilder multiFileParameters(Map<String,MultiFile> multiFileParameters)

Sets the multi file parameters to be passed to the prompt query upon execution.

Parameters:

multiFileParameters - The new multi file parameters.

Returns:

This builder for chaining methods calls.

outputFileProvision

IPromptQueryBuilder outputFileProvision(FileProvision outputFileProvision)

Sets the output file provision configuration for the prompt query action.

Parameters:

outputFileProvision - The output file provision configuration.

Returns:

This builder for chaining methods calls.

promptQuery

IPromptQueryBuilder promptQuery(ObjectReference promptQuery)

Sets the prompt query to be executed by the action.

Parameters:

promptQuery - A reference to the prompt query.

Returns:

This builder for chaining methods calls.

singleFileParameters

IPromptQueryBuilder singleFileParameters(Map<String,SingleFile> singleFileParameters)

Sets the single file parameters to be passed to the prompt query upon execution.

Parameters:

singleFileParameters - The new single file parameters.

Returns:

This builder for chaining methods calls.