```
public class Txn
extends Object
```
Provide a Transaction value object class.

Since:

5.0.0

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`attachmentsStatus`	The attachment status [ Required \| Optional \| Completed ].
`List<TxnCheckpoint>`	`checkpoints`	The list of transaction delivery checkpoints.
`String`	`clientCode`	The organization code.
`List<Map<String,String>>`	`comments`	The Workspaces comments
`boolean`	`dataDeleted`	The transaction user PII data has been deleted.
`static String`	`DELIVERY_COMPLETED`	The delivery "Completed" status.
`static String`	`DELIVERY_ERROR`	The delivery "Error" status.
`static String`	`DELIVERY_IN_PROGRESS`	The delivery "In Progress" status.
`static String`	`DELIVERY_NOT_READY`	The delivery "Not Ready" status.
`static String`	`DELIVERY_NOT_REQUIRED`	The delivery "Not Required" status.
`static String`	`DELIVERY_PENDING`	The delivery "Pending" status.
`static String`	`DELIVERY_READY`	The delivery "Ready" status.
`static String`	`DELIVERY_SENT_EMAIL`	The delivery "Sent Email" status.
`static String`	`DELIVERY_UNDELIVERABLE`	The delivery "Undeliverable" status.
`String`	`deliveryChannel`	The organization delivery channel name.
`List<TxnDeliveryFunc>`	`deliveryFuncs`	The transaction delivery functions list.
`Integer`	`deliveryMaxAttempts`	The delivery max attempts.
`String`	`deliveryMessage`	The delivery message.
`String`	`deliveryMethod`	The delivery method [ Email \| Email Secure \| Delivery Process \| REST Service \| Web Service ].
`Integer`	`deliveryProcessAttempts`	The delivery process attempts.
`String`	`deliveryStatus`	The delivery status [ Not Ready \| Ready \| Sent Email \| In Progress \| Pending \| Completed \| Error \| Undeliverable \| Not Required ].
`String`	`emailAddress`	The contact email address.
`String`	`emailVerificationStatus`	The email verification status for forms configured with anonymous email verification.
`String`	`externalUserId`	The transaction external user id.
`List<FileAttach>`	`fileAttachList`	The file attachments list.
`static String`	`FORM_ABANDONED`	The form "Abandoned" status.
`static String`	`FORM_ASSIGNED`	The form "Assigned" status.
`static String`	`FORM_COMPLETED`	The form "Completed" status.
`static String`	`FORM_EXPIRED`	The form "Expired" status.
`static String`	`FORM_OPENED`	The form "Opened" status.
`static String`	`FORM_SAVED`	The form "Saved" status.
`static String`	`FORM_SUBMITTED`	The form "Submitted" status.
`String`	`formAbandonmentType`	The type of form abandonment [ Bounced \| Started \| Cancelled \| Submitted \| Saved ].
`String`	`formCode`	The form code, globally unique identifier.
`Map<String,String>`	`formDataMap`	The form data map (data extracts).
`Long`	`formId`	The form id (PK).
`String`	`formName`	The form name.
`String`	`formStatus`	The transaction form status [ Assigned \| Opened \| Saved \| Submitted \| Completed \| Expired \| Abandoned ].
`String`	`formUrl`	The form URL if the transaction has not been completed.
`Long`	`formVersionId`	The form version id (PK).
`String`	`formVersionNumber`	The form version number.
`String`	`formXml`	The form XML data.
`Set<String>`	`groupNames`	The transaction group names.
`Long`	`id`	The transaction id (PK).
`Long`	`jobActionId`	The job action id.
`Long`	`jobId`	The job id.
`String`	`jobRefNumber`	The job reference number.
`List<String>`	`milestones`	The list of transaction milestones.
`Long`	`orgId`	The organization id (PK).
`String`	`orgName`	The organization name.
`String`	`paymentGatewayReceiptNo`	The payment gateway receipt number.
`Date`	`paymentGatewayTimestamp`	The payment gateway timestamp.
`Long`	`paymentGatewayTxnNo`	The payment gateway transaction number.
`String`	`paymentStatus`	The transaction payment status [ Required \| Completed \| Error \| Pending ].
`Double`	`paymentTotal`	The transaction payment total.
`String`	`processStatus`	The transaction processing status.
`Map<String,String>`	`propertyMap`	The property map (transaction properties).
`String`	`receiptNumber`	The transaction receipt number.
`byte[]`	`receiptPdf`	The receipt PDF bytes.
`String`	`receiptStatus`	The transaction PDF receipt generation status [ Ready \| In Progress \| Completed \| Error \| Error No Data ].
`String`	`receiptUrl`	The receipt URL if the transaction has not been completed.
`String`	`saveChallengeHash`	The save challenge hash
`Date`	`saveChallengeTimeout`	The save challenge timeout
`Long`	`spaceId`	The form space id (PK).
`String`	`spaceName`	The form space name.
`String`	`submitKey`	The transaction submit key, globally unique id (GUID).
`Date`	`timeAbandoned`	The time the transaction was abandoned.
`Date`	`timeAbandonmentScheduled`	The time the transaction was scheduled for abandonment.
`Date`	`timeCompleted`	The time the transaction was completed.
`Date`	`timeCreated`	The time the transaction was created.
`Date`	`timeDelivered`	The time the transaction was delivered.
`Date`	`timeProcessUpdated`	The time the processing status was last updated.
`Date`	`timePurgeDataActual`	The actual time the transaction PII data was purged.
`Date`	`timePurgeDataScheduled`	The time the transaction PII data is scheduled to be purged.
`Date`	`timePurgeRecordScheduled`	The time the transaction record is scheduled to be purged.
`Date`	`timeRequested`	The time the transaction was requested.
`Date`	`timeSubmissionExpiry`	Deprecated. use `timeTxnExpiry` instead
`Date`	`timeSubmitted`	The time the transaction was submitted and also for time transaction initially saved.
`Date`	`timeTaskExpiry`	The time the task will expiry.
`Date`	`timeTaskScheduled`	The time the task was scheduled to be completed.
`Date`	`timeTxnExpiry`	The time the txn will expire.
`Date`	`timeUserLastModified`	The time the user last viewed the form or performed any activity.
`String`	`trackingCode`	The transaction tracking code.
`String`	`transRefNumber`	The transaction ref number.
`Integer`	`txnScore`	The transaction score.
`String`	`userAgent`	The HTTP user agent header.
`String`	`userAgentDeviceType`	The HTTP user agent device type [ Phone \| Tablet \| Desktop \| Game Console \| Unknown ].
`String`	`userLoginName`	The transaction users login name (username).
`boolean`	`userSaved`	The transaction is user saved.

Constructor Summary

Constructors
Constructor	Description
`Txn(com.avoka.fc.core.entity.Submission sub, Map<String,String> formDataMap, String formXml, Set<String> groupNames, Map<String,String> propertyMap, byte[] receiptPdf, List<FileAttach> fileAttachList, List<TxnDeliveryFunc> deliveryFuncs, List<Map<String,String>> comments)`	Create a Txn value object with the given parameters.
`Txn(Map fields)`	Create a unit testing Txn value object with the given fields.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

String toString()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FORM_ASSIGNED
```
public static final String FORM_ASSIGNED
```
    The form "Assigned" status.
    
    See Also:
    
    Constant Field Values
  - FORM_OPENED
```
public static final String FORM_OPENED
```
    The form "Opened" status.
    
    See Also:
    
    Constant Field Values
  - FORM_SAVED
```
public static final String FORM_SAVED
```
    The form "Saved" status.
    
    See Also:
    
    Constant Field Values
  - FORM_SUBMITTED
```
public static final String FORM_SUBMITTED
```
    The form "Submitted" status.
    
    See Also:
    
    Constant Field Values
  - FORM_COMPLETED
```
public static final String FORM_COMPLETED
```
    The form "Completed" status.
    
    See Also:
    
    Constant Field Values
  - FORM_ABANDONED
```
public static final String FORM_ABANDONED
```
    The form "Abandoned" status.
    
    See Also:
    
    Constant Field Values
  - FORM_EXPIRED
```
public static final String FORM_EXPIRED
```
    The form "Expired" status.
    
    See Also:
    
    Constant Field Values
  - DELIVERY_NOT_READY
```
public static final String DELIVERY_NOT_READY
```
    The delivery "Not Ready" status.
    
    See Also:
    
    Constant Field Values
  - DELIVERY_READY
```
public static final String DELIVERY_READY
```
    The delivery "Ready" status.
    
    See Also:
    
    Constant Field Values
  - DELIVERY_SENT_EMAIL
```
public static final String DELIVERY_SENT_EMAIL
```
    The delivery "Sent Email" status.
    
    See Also:
    
    Constant Field Values
  - DELIVERY_IN_PROGRESS
```
public static final String DELIVERY_IN_PROGRESS
```
    The delivery "In Progress" status.
    
    See Also:
    
    Constant Field Values
  - DELIVERY_PENDING
```
public static final String DELIVERY_PENDING
```
    The delivery "Pending" status.
    
    See Also:
    
    Constant Field Values
  - DELIVERY_COMPLETED
```
public static final String DELIVERY_COMPLETED
```
    The delivery "Completed" status.
    
    See Also:
    
    Constant Field Values
  - DELIVERY_ERROR
```
public static final String DELIVERY_ERROR
```
    The delivery "Error" status.
    
    See Also:
    
    Constant Field Values
  - DELIVERY_UNDELIVERABLE
```
public static final String DELIVERY_UNDELIVERABLE
```
    The delivery "Undeliverable" status.
    
    See Also:
    
    Constant Field Values
  - DELIVERY_NOT_REQUIRED
```
public static final String DELIVERY_NOT_REQUIRED
```
    The delivery "Not Required" status.
    
    See Also:
    
    Constant Field Values
  - id
```
public final Long id
```
    The transaction id (PK).
  - attachmentsStatus
```
public final String attachmentsStatus
```
    The attachment status [ Required | Optional | Completed ].
  - orgId
```
public final Long orgId
```
    The organization id (PK).
  - clientCode
```
public final String clientCode
```
    The organization code.
  - orgName
```
public final String orgName
```
    The organization name.
  - deliveryStatus
```
public final String deliveryStatus
```
    The delivery status [ Not Ready | Ready | Sent Email | In Progress | Pending | Completed | Error | Undeliverable | Not Required ].
  - deliveryChannel
```
public final String deliveryChannel
```
    The organization delivery channel name.
  - deliveryMaxAttempts
```
public final Integer deliveryMaxAttempts
```
    The delivery max attempts.
  - deliveryMessage
```
public final String deliveryMessage
```
    The delivery message.
  - deliveryMethod
```
public final String deliveryMethod
```
    The delivery method [ Email | Email Secure | Delivery Process | REST Service | Web Service ].
  - deliveryProcessAttempts
```
public final Integer deliveryProcessAttempts
```
    The delivery process attempts.
  - emailAddress
```
public final String emailAddress
```
    The contact email address.
  - emailVerificationStatus
```
public final String emailVerificationStatus
```
    The email verification status for forms configured with anonymous email verification.
    
    Since:
    
    19.11.0
  - formId
```
public final Long formId
```
    The form id (PK).
  - formCode
```
public final String formCode
```
    The form code, globally unique identifier.
  - formName
```
public final String formName
```
    The form name.
  - formStatus
```
public final String formStatus
```
    The transaction form status [ Assigned | Opened | Saved | Submitted | Completed | Expired | Abandoned ].
  - groupNames
```
public final Set<String> groupNames
```
    The transaction group names.
  - paymentStatus
```
public final String paymentStatus
```
    The transaction payment status [ Required | Completed | Error | Pending ].
  - paymentTotal
```
public final Double paymentTotal
```
    The transaction payment total.
  - jobId
```
public final Long jobId
```
    The job id.
  - jobActionId
```
public final Long jobActionId
```
    The job action id.
  - jobRefNumber
```
public final String jobRefNumber
```
    The job reference number.
  - spaceId
```
public final Long spaceId
```
    The form space id (PK).
  - spaceName
```
public final String spaceName
```
    The form space name.
  - receiptNumber
```
public final String receiptNumber
```
    The transaction receipt number.
  - receiptStatus
```
public final String receiptStatus
```
    The transaction PDF receipt generation status [ Ready | In Progress | Completed | Error | Error No Data ].
  - saveChallengeHash
```
public final String saveChallengeHash
```
    The save challenge hash
    
    Since:
    
    5.1.0
  - saveChallengeTimeout
```
public final Date saveChallengeTimeout
```
    The save challenge timeout
    
    Since:
    
    5.1.0
  - timeCreated
```
public final Date timeCreated
```
    The time the transaction was created.
  - timeAbandoned
```
public final Date timeAbandoned
```
    The time the transaction was abandoned.
  - timeAbandonmentScheduled
```
public final Date timeAbandonmentScheduled
```
    The time the transaction was scheduled for abandonment.
    
    Since:
    
    19.11.0
  - timeUserLastModified
```
public final Date timeUserLastModified
```
    The time the user last viewed the form or performed any activity.
  - timeSubmitted
```
public final Date timeSubmitted
```
    The time the transaction was submitted and also for time transaction initially saved.
  - timeCompleted
```
public final Date timeCompleted
```
    The time the transaction was completed.
  - timeDelivered
```
public final Date timeDelivered
```
    The time the transaction was delivered.
  - timeProcessUpdated
```
public final Date timeProcessUpdated
```
    The time the processing status was last updated.
  - timePurgeDataScheduled
```
public final Date timePurgeDataScheduled
```
    The time the transaction PII data is scheduled to be purged.
    
    Since:
    
    19.11.0
  - timePurgeDataActual
```
public final Date timePurgeDataActual
```
    The actual time the transaction PII data was purged.
    
    Since:
    
    19.11.0
  - timePurgeRecordScheduled
```
public final Date timePurgeRecordScheduled
```
    The time the transaction record is scheduled to be purged.
    
    Since:
    
    19.11.0
  - timeRequested
```
public final Date timeRequested
```
    The time the transaction was requested.
    
    Since:
    
    19.11.0
  - timeSubmissionExpiry
```
public final Date timeSubmissionExpiry
```
    Deprecated.
    use timeTxnExpiry instead
    
    The time the submission will expire.
  - timeTaskExpiry
```
public final Date timeTaskExpiry
```
    The time the task will expiry.
  - timeTaskScheduled
```
public final Date timeTaskScheduled
```
    The time the task was scheduled to be completed.
  - timeTxnExpiry
```
public final Date timeTxnExpiry
```
    The time the txn will expire.
    
    Since:
    
    19.11.0
  - dataDeleted
```
public final boolean dataDeleted
```
    The transaction user PII data has been deleted.
  - submitKey
```
public final String submitKey
```
    The transaction submit key, globally unique id (GUID).
  - trackingCode
```
public final String trackingCode
```
    The transaction tracking code.
  - transRefNumber
```
public final String transRefNumber
```
    The transaction ref number.
    
    Since:
    
    18.11.0
  - userLoginName
```
public final String userLoginName
```
    The transaction users login name (username).
  - userSaved
```
public final boolean userSaved
```
    The transaction is user saved.
    
    Since:
    
    5.0.3
  - externalUserId
```
public final String externalUserId
```
    The transaction external user id.
  - paymentGatewayTimestamp
```
public final Date paymentGatewayTimestamp
```
    The payment gateway timestamp.
  - paymentGatewayReceiptNo
```
public final String paymentGatewayReceiptNo
```
    The payment gateway receipt number.
  - paymentGatewayTxnNo
```
public final Long paymentGatewayTxnNo
```
    The payment gateway transaction number.
  - processStatus
```
public final String processStatus
```
    The transaction processing status.
  - formVersionId
```
public final Long formVersionId
```
    The form version id (PK).
  - formVersionNumber
```
public final String formVersionNumber
```
    The form version number.
  - txnScore
```
public final Integer txnScore
```
    The transaction score.
  - userAgent
```
public final String userAgent
```
    The HTTP user agent header.
    
    Since:
    
    18.11.0
  - userAgentDeviceType
```
public final String userAgentDeviceType
```
    The HTTP user agent device type [ Phone | Tablet | Desktop | Game Console | Unknown ].
    
    Since:
    
    18.11.0
  - formAbandonmentType
```
public final String formAbandonmentType
```
    The type of form abandonment [ Bounced | Started | Cancelled | Submitted | Saved ].
  - formUrl
```
public final String formUrl
```
    The form URL if the transaction has not been completed.
  - receiptUrl
```
public final String receiptUrl
```
    The receipt URL if the transaction has not been completed.
  - checkpoints
```
public final List<TxnCheckpoint> checkpoints
```
    The list of transaction delivery checkpoints.
  - formDataMap
```
public final Map<String,String> formDataMap
```
    The form data map (data extracts).
  - propertyMap
```
public final Map<String,String> propertyMap
```
    The property map (transaction properties).
  - milestones
```
public final List<String> milestones
```
    The list of transaction milestones.
  - formXml
```
public final String formXml
```
    The form XML data.
  - receiptPdf
```
public final byte[] receiptPdf
```
    The receipt PDF bytes.
  - fileAttachList
```
public final List<FileAttach> fileAttachList
```
    The file attachments list.
  - deliveryFuncs
```
public final List<TxnDeliveryFunc> deliveryFuncs
```
    The transaction delivery functions list.
  - comments
```
public final List<Map<String,String>> comments
```
    The Workspaces comments
    
    Since:
    
    19.11.0
- Constructor Detail
  - Txn
```
public Txn(com.avoka.fc.core.entity.Submission sub,
           Map<String,String> formDataMap,
           String formXml,
           Set<String> groupNames,
           Map<String,String> propertyMap,
           byte[] receiptPdf,
           List<FileAttach> fileAttachList,
           List<TxnDeliveryFunc> deliveryFuncs,
           List<Map<String,String>> comments)
```
    Create a Txn value object with the given parameters.
    
    Parameters:
    
    sub - the submission entity (required)
    
    formDataMap - the form data map
    
    formXml - the form XML data
    
    groupNames - the submission group names
    
    propertyMap - the submission property
    
    receiptPdf - the receipt PDF bytes
    
    fileAttachList - the file attachments list
    
    deliveryFuncs - the transaction delivery functions
  - Txn
```
public Txn(Map fields)
```
    Create a unit testing Txn value object with the given fields.
    
    Parameters:
    
    fields - the submission entity fields (required)
    
    Since:
    
    5.1.4
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.

Class Txn

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FORM_ASSIGNED

FORM_OPENED

FORM_SAVED

FORM_SUBMITTED

FORM_COMPLETED

FORM_ABANDONED

FORM_EXPIRED

DELIVERY_NOT_READY

DELIVERY_READY

DELIVERY_SENT_EMAIL

DELIVERY_IN_PROGRESS

DELIVERY_PENDING

DELIVERY_COMPLETED

DELIVERY_ERROR

DELIVERY_UNDELIVERABLE

DELIVERY_NOT_REQUIRED

id

attachmentsStatus

orgId

clientCode

orgName

deliveryStatus

deliveryChannel

deliveryMaxAttempts

deliveryMessage

deliveryMethod

deliveryProcessAttempts

emailAddress

emailVerificationStatus

formId

formCode

formName

formStatus

groupNames

paymentStatus

paymentTotal

jobId

jobActionId

jobRefNumber

spaceId

spaceName

receiptNumber

receiptStatus

saveChallengeHash

saveChallengeTimeout

timeCreated

timeAbandoned

timeAbandonmentScheduled

timeUserLastModified

timeSubmitted

timeCompleted

timeDelivered

timeProcessUpdated

timePurgeDataScheduled

timePurgeDataActual

timePurgeRecordScheduled

timeRequested

timeSubmissionExpiry

timeTaskExpiry

timeTaskScheduled

timeTxnExpiry

dataDeleted

submitKey

trackingCode

transRefNumber

userLoginName

userSaved

externalUserId

paymentGatewayTimestamp

paymentGatewayReceiptNo

paymentGatewayTxnNo

processStatus

formVersionId

formVersionNumber