Package com.avoka.tm.vo

Class TxnVoBuilder

  • public class TxnVoBuilder
extends Object
    Provides a Txn value object builder class.
    Since:
    18.11.0

    • Constructor Detail

      • TxnVoBuilder

        public TxnVoBuilder()

    • Method Detail

      • withAll

        public TxnVoBuilder withAll()
        Specify whether to include all txn attributes
        Returns:
        this TxnVoBuilder

      • withFormDataMap

        public TxnVoBuilder withFormDataMap​(boolean withFormDataMap)
        Specify whether to include form data map extracts
        Parameters:
        withFormDataMap - specify whether to include form data map extracts
        Returns:
        this TxnVoBuilder

      • withFormXml

        public TxnVoBuilder withFormXml​(boolean withFormXml)
        Specify whether to include form XML data.
        Parameters:
        withFormXml - specify whether to include form xML data
        Returns:
        this TxnVoBuilder

      • withGroupNames

        public TxnVoBuilder withGroupNames​(boolean withGroupNames)
        Specify whether to include group names list.
        Parameters:
        withGroupNames - specify whether to include group names list
        Returns:
        this TxnVoBuilder

      • withPropertyMap

        public TxnVoBuilder withPropertyMap​(boolean withPropertyMap)
        Specify whether to include property map.
        Parameters:
        withPropertyMap - specify whether to include property map
        Returns:
        this TxnVoBuilder

      • withReceiptPdf

        public TxnVoBuilder withReceiptPdf​(boolean withReceiptPdf)
        Specify whether to include receipt PDF data.
        Parameters:
        withReceiptPdf - specify whether to include receipt PDF data
        Returns:
        this TxnVoBuilder

      • withFileAttachList

        public TxnVoBuilder withFileAttachList​(boolean withFileAttachList)
        Specify whether to include file attachment list.
        Parameters:
        withFileAttachList - specify whether to include file attachment list
        Returns:
        this TxnVoBuilder

      • withDeliveryFuncs

        public TxnVoBuilder withDeliveryFuncs​(boolean withDeliveryFuncs)
        Specify whether to include delivery functions list.
        Parameters:
        withDeliveryFuncs - specify whether to include delivery functions list
        Returns:
        this TxnVoBuilder

      • withComments

        public TxnVoBuilder withComments​(boolean withComments)
        Specify whether to include workspaces comments.
        Parameters:
        withComments - specify whether to include workspaces comments
        Returns:
        this TxnVoBuilder
        Since:
        19.11.0

      • build

        public Txn build​(com.avoka.fc.core.entity.Submission submission)
        Return a new Txn value object for the given submission record and fetch parameters.
        Parameters:
        submission - the submission record (required)
        Returns:
        a new Txn value object for the given submission record and fetch parameters