Class Txn

public class Txn
extends java.lang.Object
Provide a Transaction value object class.
Since:
5.0.0

Field Summary

Fields
Modifier and Type Field Description
java.lang.String attachmentsStatus The attachment status [ Required | Optional | Completed ].
java.util.List<TxnCheckpoint> checkpoints The list of transaction delivery checkpoints.
java.lang.String clientCode The organization code.
boolean dataDeleted The transaction user PII data has been deleted.
static java.lang.String DELIVERY_COMPLETED The delivery "Completed" status.
static java.lang.String DELIVERY_ERROR The delivery "Error" status.
static java.lang.String DELIVERY_IN_PROGRESS The delivery "In Progress" status.
static java.lang.String DELIVERY_NOT_READY The delivery "Not Ready" status.
static java.lang.String DELIVERY_NOT_REQUIRED The delivery "Not Required" status.
static java.lang.String DELIVERY_PENDING The delivery "Pending" status.
static java.lang.String DELIVERY_READY The delivery "Ready" status.
static java.lang.String DELIVERY_SENT_EMAIL The delivery "Sent Email" status.
static java.lang.String DELIVERY_UNDELIVERABLE The delivery "Undeliverable" status.
java.lang.String deliveryChannel The organization delivery channel name.
java.util.List<TxnDeliveryFunc> deliveryFuncs The transaction delivery functions list.
java.lang.Integer deliveryMaxAttempts The delivery max attempts.
java.lang.String deliveryMessage The delivery message.
java.lang.String deliveryMethod The delivery method [ Email | Email Secure | Delivery Process | REST Service | Web Service ].
java.lang.Integer deliveryProcessAttempts The delivery process attempts.
java.lang.String deliveryStatus The delivery status [ Not Ready | Ready | Sent Email | In Progress | Pending | Completed | Error | Undeliverable | Not Required ].
java.lang.String emailAddress The contact email address.
java.lang.String externalUserId The transaction external user id.
java.util.List<FileAttach> fileAttachList The file attachments list.
static java.lang.String FORM_ABANDONED The form "Abandoned" status.
static java.lang.String FORM_ASSIGNED The form "Assigned" status.
static java.lang.String FORM_COMPLETED The form "Completed" status.
static java.lang.String FORM_EXPIRED The form "Expired" status.
static java.lang.String FORM_OPENED The form "Opened" status.
static java.lang.String FORM_SAVED The form "Saved" status.
static java.lang.String FORM_SUBMITTED The form "Submitted" status.
java.lang.String formAbandonmentType The type of form abandonment [ Bounced | Started | Cancelled | Submitted | Saved ].
java.lang.String formCode The form code, globally unique identifier.
java.util.Map<java.lang.String,​java.lang.String> formDataMap The form data map (data extracts).
java.lang.Long formId The form id (PK).
java.lang.String formName The form name.
java.lang.String formStatus The transaction form status [ Assigned | Opened | Saved | Submitted | Completed | Expired | Abandoned ].
java.lang.String formUrl The form URL if the transaction has not been completed.
java.lang.Long formVersionId The form version id (PK).
java.lang.String formVersionNumber The form version number.
java.lang.String formXml The form XML data.
java.util.Set<java.lang.String> groupNames The transaction group names.
java.lang.Long id The transaction id (PK).
java.lang.Long jobActionId The job action id.
java.lang.Long jobId The job id.
java.lang.String jobRefNumber The job reference number.
java.util.List<java.lang.String> milestones The list of transaction milestones.
java.lang.Long orgId The organization id (PK).
java.lang.String orgName The organization name.
java.lang.String paymentGatewayReceiptNo The payment gateway receipt number.
java.util.Date paymentGatewayTimestamp The payment gateway timestamp.
java.lang.Long paymentGatewayTxnNo The payment gateway transaction number.
java.lang.String paymentStatus The transaction payment status [ Required | Completed | Error | Pending ].
java.lang.Double paymentTotal The transaction payment total.
java.lang.String processStatus The transaction processing status.
java.util.Map<java.lang.String,​java.lang.String> propertyMap The property map (transaction properties).
java.lang.String receiptNumber The transaction receipt number.
byte[] receiptPdf The receipt PDF bytes.
java.lang.String receiptStatus The transaction PDF receipt generation status [ Ready | In Progress | Completed | Error | Error No Data ].
java.lang.String receiptUrl The receipt URL if the transaction has not been completed.
java.lang.String saveChallengeHash The save challenge hash
java.util.Date saveChallengeTimeout The save challenge timeout
java.lang.Long spaceId The form space id (PK).
java.lang.String spaceName The form space name.
java.lang.String submitKey The transaction submit key, globally unique id (GUID).
java.util.Date timeAbandoned The time the transaction was abandoned.
java.util.Date timeCompleted The time the transaction was completed.
java.util.Date timeCreated The time the transaction was created.
java.util.Date timeDelivered The time the transaction was delivered.
java.util.Date timeProcessUpdated The time the processing status was last updated.
java.util.Date timeSubmissionExpiry The time the submission will expire.
java.util.Date timeSubmitted The time the transaction was submitted.
java.util.Date timeTaskExpiry The time the task will expiry.
java.util.Date timeTaskScheduled The time the task was scheduled to be completed.
java.util.Date timeUserLastModified The time the user last modified the transaction.
java.lang.String trackingCode The transaction tracking code.
java.lang.String transRefNumber The transaction ref number.
java.lang.Integer txnScore The transaction score.
java.lang.String userAgent The HTTP user agent header.
java.lang.String userAgentDeviceType The HTTP user agent device type [ Phone | Tablet | Desktop | Game Console | Unknown ].
java.lang.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,
   java.util.Map<java.lang.String,​java.lang.String> formDataMap,
   java.lang.String formXml,
   java.util.Set<java.lang.String> groupNames,
   java.util.Map<java.lang.String,​java.lang.String> propertyMap,
   byte[] receiptPdf,
   java.util.List<FileAttach> fileAttachList,
   java.util.List<TxnDeliveryFunc> deliveryFuncs)
 Create a Txn value object with the given parameters.
Txn​(java.util.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
java.lang.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 java.lang.String FORM_ASSIGNED The form "Assigned" status.
See Also:
Constant Field Values

FORM_OPENED

public static final java.lang.String FORM_OPENED The form "Opened" status.
See Also:
Constant Field Values

FORM_SAVED

public static final java.lang.String FORM_SAVED The form "Saved" status.
See Also:
Constant Field Values

FORM_SUBMITTED

public static final java.lang.String FORM_SUBMITTED The form "Submitted" status.
See Also:
Constant Field Values

FORM_COMPLETED

public static final java.lang.String FORM_COMPLETED The form "Completed" status.
See Also:
Constant Field Values

FORM_ABANDONED

public static final java.lang.String FORM_ABANDONED The form "Abandoned" status.
See Also:
Constant Field Values

FORM_EXPIRED

public static final java.lang.String FORM_EXPIRED The form "Expired" status.
See Also:
Constant Field Values

DELIVERY_NOT_READY

public static final java.lang.String DELIVERY_NOT_READY The delivery "Not Ready" status.
See Also:
Constant Field Values

DELIVERY_READY

public static final java.lang.String DELIVERY_READY The delivery "Ready" status.
See Also:
Constant Field Values

DELIVERY_SENT_EMAIL

public static final java.lang.String DELIVERY_SENT_EMAIL The delivery "Sent Email" status.
See Also:
Constant Field Values

DELIVERY_IN_PROGRESS

public static final java.lang.String DELIVERY_IN_PROGRESS The delivery "In Progress" status.
See Also:
Constant Field Values

DELIVERY_PENDING

public static final java.lang.String DELIVERY_PENDING The delivery "Pending" status.
See Also:
Constant Field Values

DELIVERY_COMPLETED

public static final java.lang.String DELIVERY_COMPLETED The delivery "Completed" status.
See Also:
Constant Field Values

DELIVERY_ERROR

public static final java.lang.String DELIVERY_ERROR The delivery "Error" status.
See Also:
Constant Field Values

DELIVERY_UNDELIVERABLE

public static final java.lang.String DELIVERY_UNDELIVERABLE The delivery "Undeliverable" status.
See Also:
Constant Field Values

DELIVERY_NOT_REQUIRED

public static final java.lang.String DELIVERY_NOT_REQUIRED The delivery "Not Required" status.
See Also:
Constant Field Values

id

public final java.lang.Long id The transaction id (PK).

attachmentsStatus

public final java.lang.String attachmentsStatus The attachment status [ Required | Optional | Completed ].

orgId

public final java.lang.Long orgId The organization id (PK).

clientCode

public final java.lang.String clientCode The organization code.

orgName

public final java.lang.String orgName The organization name.

deliveryStatus

public final java.lang.String deliveryStatus The delivery status [ Not Ready | Ready | Sent Email | In Progress | Pending | Completed | Error | Undeliverable | Not Required ].

deliveryChannel

public final java.lang.String deliveryChannel The organization delivery channel name.

deliveryMaxAttempts

public final java.lang.Integer deliveryMaxAttempts The delivery max attempts.

deliveryMessage

public final java.lang.String deliveryMessage The delivery message.

deliveryMethod

public final java.lang.String deliveryMethod The delivery method [ Email | Email Secure | Delivery Process | REST Service | Web Service ].

deliveryProcessAttempts

public final java.lang.Integer deliveryProcessAttempts The delivery process attempts.

emailAddress

public final java.lang.String emailAddress The contact email address.

formId

public final java.lang.Long formId The form id (PK).

formCode

public final java.lang.String formCode The form code, globally unique identifier.

formName

public final java.lang.String formName The form name.

formStatus

public final java.lang.String formStatus The transaction form status [ Assigned | Opened | Saved | Submitted | Completed | Expired | Abandoned ].

groupNames

public final java.util.Set<java.lang.String> groupNames The transaction group names.

paymentStatus

public final java.lang.String paymentStatus The transaction payment status [ Required | Completed | Error | Pending ].

paymentTotal

public final java.lang.Double paymentTotal The transaction payment total.

jobId

public final java.lang.Long jobId The job id.

jobActionId

public final java.lang.Long jobActionId The job action id.

jobRefNumber

public final java.lang.String jobRefNumber The job reference number.

spaceId

public final java.lang.Long spaceId The form space id (PK).

spaceName

public final java.lang.String spaceName The form space name.

receiptNumber

public final java.lang.String receiptNumber The transaction receipt number.

receiptStatus

public final java.lang.String receiptStatus The transaction PDF receipt generation status [ Ready | In Progress | Completed | Error | Error No Data ].

saveChallengeHash

public final java.lang.String saveChallengeHash The save challenge hash
Since:
5.1.0

saveChallengeTimeout

public final java.util.Date saveChallengeTimeout The save challenge timeout
Since:
5.1.0

timeCreated

public final java.util.Date timeCreated The time the transaction was created.

timeAbandoned

public final java.util.Date timeAbandoned The time the transaction was abandoned.

timeUserLastModified

public final java.util.Date timeUserLastModified The time the user last modified the transaction.

timeSubmitted

public final java.util.Date timeSubmitted The time the transaction was submitted.

timeCompleted

public final java.util.Date timeCompleted The time the transaction was completed.

timeDelivered

public final java.util.Date timeDelivered The time the transaction was delivered.

timeProcessUpdated

public final java.util.Date timeProcessUpdated The time the processing status was last updated.

timeSubmissionExpiry

public final java.util.Date timeSubmissionExpiry The time the submission will expire.

timeTaskExpiry

public final java.util.Date timeTaskExpiry The time the task will expiry.

timeTaskScheduled

public final java.util.Date timeTaskScheduled The time the task was scheduled to be completed.

dataDeleted

public final boolean dataDeleted The transaction user PII data has been deleted.

submitKey

public final java.lang.String submitKey The transaction submit key, globally unique id (GUID).

trackingCode

public final java.lang.String trackingCode The transaction tracking code.

transRefNumber

public final java.lang.String transRefNumber The transaction ref number.
Since:
18.11.0

userLoginName

public final java.lang.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 java.lang.String externalUserId The transaction external user id.

paymentGatewayTimestamp

public final java.util.Date paymentGatewayTimestamp The payment gateway timestamp.

paymentGatewayReceiptNo

public final java.lang.String paymentGatewayReceiptNo The payment gateway receipt number.

paymentGatewayTxnNo

public final java.lang.Long paymentGatewayTxnNo The payment gateway transaction number.

processStatus

public final java.lang.String processStatus The transaction processing status.

formVersionId

public final java.lang.Long formVersionId The form version id (PK).

formVersionNumber

public final java.lang.String formVersionNumber The form version number.

txnScore

public final java.lang.Integer txnScore The transaction score.

userAgent

public final java.lang.String userAgent The HTTP user agent header.
Since:
18.11.0

userAgentDeviceType

public final java.lang.String userAgentDeviceType The HTTP user agent device type [ Phone | Tablet | Desktop | Game Console | Unknown ].
Since:
18.11.0

formAbandonmentType

public final java.lang.String formAbandonmentType The type of form abandonment [ Bounced | Started | Cancelled | Submitted | Saved ].

formUrl

public final java.lang.String formUrl The form URL if the transaction has not been completed.

receiptUrl

public final java.lang.String receiptUrl The receipt URL if the transaction has not been completed.

checkpoints

public final java.util.List<TxnCheckpoint> checkpoints The list of transaction delivery checkpoints.

formDataMap

public final java.util.Map<java.lang.String,​java.lang.String> formDataMap The form data map (data extracts).

propertyMap

public final java.util.Map<java.lang.String,​java.lang.String> propertyMap The property map (transaction properties).

milestones

public final java.util.List<java.lang.String> milestones The list of transaction milestones.

formXml

public final java.lang.String formXml The form XML data.

receiptPdf

public final byte[] receiptPdf The receipt PDF bytes.

fileAttachList

public final java.util.List<FileAttach> fileAttachList The file attachments list.

deliveryFuncs

public final java.util.List<TxnDeliveryFunc> deliveryFuncs The transaction delivery functions list.

Constructor Detail

Txn

public Txn​(com.avoka.fc.core.entity.Submission sub,
           java.util.Map<java.lang.String,​java.lang.String> formDataMap,
           java.lang.String formXml,
           java.util.Set<java.lang.String> groupNames,
           java.util.Map<java.lang.String,​java.lang.String> propertyMap,
           byte[] receiptPdf,
           java.util.List<FileAttach> fileAttachList,
           java.util.List<TxnDeliveryFunc> deliveryFuncs)
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​(java.util.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 java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
a string representation of the object.
← Class SvcDefClass TxnCheckpoint →