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

Interface ICreateTextFileNodeBuilder

public interface ICreateTextFileNodeBuilder

Builder for configuring a EWorkflowNodeType.FC_CREATE_TEXT_FILE action.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
ICreateTextFileNodeBuilder	attachToFormRecord(boolean attachToFormRecord)
ICreateTextFileNodeBuilder	bomMode(EByteOrderMarkMode bomMode)
WorkflowNode	build()	Creates a new workflow node for a EWorkflowNodeType.FC_CREATE_TEXT_FILE that creates a text file.
FcCreateTextFileProps	buildProps()	Creates a new properties model for a node that creates a text file.
ICreateTextFileNodeBuilder	charset(Charset charset)
ICreateTextFileNodeBuilder	contentType(ETextFileContentType contentType)
ICreateTextFileNodeBuilder	fileContent(String fileContent)
ICreateTextFileNodeBuilder	fileName(String fileName)

Method Detail

attachToFormRecord

ICreateTextFileNodeBuilder attachToFormRecord(boolean attachToFormRecord)

Parameters:

attachToFormRecord - Whether to attach the created text file to the form record.

Returns:

This builder for chaining methods calls.

bomMode

ICreateTextFileNodeBuilder bomMode(EByteOrderMarkMode bomMode)

Parameters:

bomMode - Byte order mark mode to use.

Returns:

This builder for chaining methods calls.

build

WorkflowNode build()
            throws FastJsonException

Creates a new workflow node for a EWorkflowNodeType.FC_CREATE_TEXT_FILE that creates a text file.

Returns:

The workflow node for a "create text file" action.

Throws:

FastJsonException - When the properties model could not be serialized.

buildProps

FcCreateTextFileProps buildProps()

Creates a new properties model for a node that creates a text file.

Returns:

The model for a "create text file" action.

charset

ICreateTextFileNodeBuilder charset(Charset charset)

Parameters:

charset - Charset for encoding the bytes when writing the text file.

Returns:

This builder for chaining methods calls.

contentType

ICreateTextFileNodeBuilder contentType(ETextFileContentType contentType)

Parameters:

contentType - Expected content type of the text file, used for escaping inserted variables.

Returns:

This builder for chaining methods calls.

fileContent

ICreateTextFileNodeBuilder fileContent(String fileContent)

Parameters:

fileContent - Plain text content of the text file.

Returns:

This builder for chaining methods calls.

fileName

ICreateTextFileNodeBuilder fileName(String fileName)

Parameters:

fileName - Name of the created text file.

Returns:

This builder for chaining methods calls.