Class DeliveryTxnBuilder

public class DeliveryTxnBuilder
extends java.lang.Object

Provides a delivery transaction builder class. Delivery only transactions are intended for delivering transaction data to systems of record. These transactions are not included in analytics and do not consume transaction licensing units. They are typically used in collaboration jobs where you have many assigned tasks being completed, but the results and associated file attachments are rolled up into one delivery transaction. Examples Provides a job delivery transaction example, where a transaction is created specifically for delivery purposes.

 import com.avoka.tm.svc.*
 import com.avoka.tm.vo.*
 String deliveryXml = ...
 FileAttach fileAttach = ...
 JobAction jobAction = ...
 Txn txn = new DeliveryTxnBuilder()
     .setFormCode("FTX-CCA")
     .setFormXml(deliveryXml)
     .setJobAction(jobAction)
     .addFileAttach(fileAttach)
     .build() 

Since:

5.0.0

Constructor Summary

Constructors

Constructor	Description
DeliveryTxnBuilder()

Method Summary

All Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
DeliveryTxnBuilder	addFileAttach​(FileAttach fileAttach)	Add the file attachment to the transaction (optional).
DeliveryTxnBuilder	addFormDataExtract​(java.lang.String name, java.lang.String value)	Add form data (data extract) to the transaction.
Txn	build()	Build a delivery transaction with a Delivery Status of "Ready" using the specified parameters.
DeliveryTxnBuilder	includeAllJobFileAttach()	Specify to included all the job transaction file attachments with the delivery transaction (optional).
DeliveryTxnBuilder	setFormCode​(java.lang.String formCode)	Set the transaction form code (required).
DeliveryTxnBuilder	setFormXml​(java.lang.String formXml)	Set the transaction form XML data to be delivered (optional).
DeliveryTxnBuilder	setJobAction​(JobAction jobAction)	Set the job action and job to be associated with the transaction (optional).
DeliveryTxnBuilder	setReceiptData​(byte[] receiptData)	Set the PDF receipt data to be delivered (optional).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeliveryTxnBuilder

public DeliveryTxnBuilder()

Method Detail

setFormCode

public DeliveryTxnBuilder setFormCode​(java.lang.String formCode) Set the transaction form code (required).

Parameters:

formCode - the formCode to set

Returns:

delivery transaction builder

setFormXml

public DeliveryTxnBuilder setFormXml​(java.lang.String formXml) Set the transaction form XML data to be delivered (optional). IF not specified a empty form XML document will be delivered.

Parameters:

formXml - the form XML data

Returns:

delivery transaction builder

setReceiptData

public DeliveryTxnBuilder setReceiptData​(byte[] receiptData) Set the PDF receipt data to be delivered (optional). If not specified a blank PDF receipt will be delivered.

Parameters:

receiptData - the PDF receipt data

Returns:

delivery transaction builder

setJobAction

public DeliveryTxnBuilder setJobAction​(JobAction jobAction) Set the job action and job to be associated with the transaction (optional).

Parameters:

jobAction - the job action to associate the transaction with

Returns:

delivery transaction builder

addFileAttach

public DeliveryTxnBuilder addFileAttach​(FileAttach fileAttach) Add the file attachment to the transaction (optional).

Parameters:

fileAttach - the file attachment to add (required)

Returns:

delivery transaction builder

includeAllJobFileAttach

public DeliveryTxnBuilder includeAllJobFileAttach() Specify to included all the job transaction file attachments with the delivery transaction (optional).

Returns:

delivery transaction builder

addFormDataExtract

public DeliveryTxnBuilder addFormDataExtract​(java.lang.String name,
                                             java.lang.String value)

Add form data (data extract) to the transaction.

Parameters:

name - form data (extract) name

value - form data (extract) value

Returns:

delivery transaction builder

build

public Txn build() Build a delivery transaction with a Delivery Status of "Ready" using the specified parameters.

Returns:

a delivery transaction with a Delivery Status of "Ready" using the specified parameters