Interface ICreateTextFileNodeBuilder

All Superinterfaces:
IBaseActionPropsBuilder<ICreateTextFileNodeBuilder, FcCreateTextFileProps>, IWorkflowElementBuilder<WorkflowNode, FcCreateTextFileProps>
public interface ICreateTextFileNodeBuilder extends IBaseActionPropsBuilder<ICreateTextFileNodeBuilder, FcCreateTextFileProps>
Builder for configuring a EWorkflowNodeType.FC_CREATE_TEXT_FILE action.
Since:
8.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • attachToFormRecord

      default ICreateTextFileNodeBuilder attachToFormRecord()
      Attaches the created text file to the form record.
      Returns:
      This builder for chaining methods calls.

    • 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.

    • attachmentAccessibleToEndUser

      ICreateTextFileNodeBuilder attachmentAccessibleToEndUser(boolean attachToFormRecord)
      Parameters:
      attachToFormRecord - Whether the attachment is accessible to the end user, e.g. in the user portal.
      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.

    • 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.

    • textFileProvision

      ICreateTextFileNodeBuilder textFileProvision(FileProvision bodyFileProvision)
      Sets the options for how to handle the text file.
      Parameters:
      bodyFileProvision - The options for how to handle the text file.
      Returns:
      This builder for chaining methods calls.