Package com.avoka.tm.vo
Class Txn
java.lang.Object
com.avoka.tm.vo.Txn
Provide a Transaction value object class.
- Since:
- 5.0.0
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The delivery "Completed" status.static final String
The delivery "Error" status.static final String
The delivery "In Progress" status.static final String
The delivery "Not Ready" status.static final String
The delivery "Not Required" status.static final String
The delivery "Pending" status.static final String
The delivery "Ready" status.static final String
The delivery "Sent Email" status.static final String
The delivery "Undeliverable" status.static final String
The form "Abandoned" status.static final String
The form "Assigned" status.static final String
The form "Completed" status.static final String
The form "Expired" status.static final String
The form "Opened" status.static final String
The form "Saved" status.static final String
The form "Submitted" status.static final String
The "JS App" form typestatic final String
The "Maestro Form" form typestatic final String
The "Other Document" form typestatic final String
The "Static PDF Form" form type -
Constructor Summary
ConstructorDescriptionTxn()
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<Comment> commentList) Create a Txn value object with the given parameters.Create a unit testing Txn value object with the given fields. -
Method Summary
Modifier and TypeMethodDescriptionThe attachment status [ Required | Optional | Completed ].The list of transaction delivery checkpoints.The organization code.The txn commentsDeprecated.The transaction created by username.The organization delivery channel name.The transaction delivery functions list.The delivery max attempts.The delivery message.The delivery method [ Email | Email Secure | Delivery Process | REST Service | Web Service ].The delivery process attempts.The delivery status [ Not Ready | Ready | Sent Email | In Progress | Pending | Completed | Error | Undeliverable | Not Required ].The contact email address.The email verification status for forms configured with anonymous email verification.The transaction external user id.The file attachments list.The type of form abandonment [ Bounced | Started | Cancelled | Submitted | Saved ].The form code, globally unique identifier.The form data map (data extracts).The form id (PK).The form name.The transaction form status [ Assigned | Opened | Saved | Submitted | Completed | Expired | Abandoned ].The abandonment form status.The transaction form type [ Composer SmartForm | Maestro Form | JS App, Static PDF Form | Other Document].The form URL if the transaction has not been completed.The form version id (PK).The form version number.The form XML data.The transaction group names.getId()
The transaction id (PK).The job action id.getJobId()
The job id.The job reference number.The transaction linked id.The list of transaction milestones.getOrgId()
The organization id (PK).The organization name.The payment gateway receipt number.The payment gateway timestamp.The payment gateway transaction number.The transaction payment status [ Required | Completed | Error | Pending ].The transaction payment total.The transaction processing status.The property map (transaction properties).The transaction receipt number.byte[]
The receipt PDF bytes.The transaction PDF receipt generation status [ Ready | In Progress | Completed | Error | Error No Data ].The receipt URL if the transaction has not been completed.The save challenge failuresThe save challenge hashThe save challenge last failureThe save challenge timeoutThe form space id (PK).The form space name.The transaction submit key, globally unique id (GUID).The task address.The task key.The task latitude.The task longitude.The task subject.The time the transaction was abandoned.The time the transaction was scheduled for abandonment.The time the transaction was completed.The time the transaction was created.The time the transaction was delivered.The time the processing status was last updated.The actual time the transaction PII data was purged.The time the transaction PII data is scheduled to be purged.The time the transaction record is scheduled to be purged.The time the transaction was requested.Deprecated.usegetTimeTxnExpiry()
insteadThe time the transaction was submitted.The time task was created.The time the task will expiry.The time the task was scheduled to be completed.The time the txn will expire.The time the user last modified the transaction.The transaction tracking code.The transaction ref number.The transaction score.The HTTP user agent header.The HTTP user agent device type [ Phone | Tablet | Desktop | Game Console | Unknown ].The transaction users login name (username).boolean
The billable flag.boolean
The transaction user PII data has been deleted.boolean
The task user deletable flag.boolean
The transaction is user saved.toString()
-
Field Details
-
FORM_ASSIGNED
The form "Assigned" status.- See Also:
-
FORM_OPENED
The form "Opened" status.- See Also:
-
FORM_SAVED
The form "Saved" status.- See Also:
-
FORM_SUBMITTED
The form "Submitted" status.- See Also:
-
FORM_COMPLETED
The form "Completed" status.- See Also:
-
FORM_ABANDONED
The form "Abandoned" status.- See Also:
-
FORM_EXPIRED
The form "Expired" status.- See Also:
-
FORM_TYPE_JS_APP
The "JS App" form type- Since:
- 21.5.0
- See Also:
-
FORM_TYPE_MAESTRO_FORM
The "Maestro Form" form type- Since:
- 21.5.0
- See Also:
-
FORM_TYPE_STATIC_PDF_FORM
The "Static PDF Form" form type- Since:
- 21.5.0
- See Also:
-
FORM_TYPE_OTHER_DOCUMENT
The "Other Document" form type- Since:
- 21.5.0
- See Also:
-
DELIVERY_NOT_READY
The delivery "Not Ready" status.- See Also:
-
DELIVERY_READY
The delivery "Ready" status.- See Also:
-
DELIVERY_SENT_EMAIL
The delivery "Sent Email" status.- See Also:
-
DELIVERY_IN_PROGRESS
The delivery "In Progress" status.- See Also:
-
DELIVERY_PENDING
The delivery "Pending" status.- See Also:
-
DELIVERY_COMPLETED
The delivery "Completed" status.- See Also:
-
DELIVERY_ERROR
The delivery "Error" status.- See Also:
-
DELIVERY_UNDELIVERABLE
The delivery "Undeliverable" status.- See Also:
-
DELIVERY_NOT_REQUIRED
The delivery "Not Required" status.- See Also:
-
-
Constructor Details
-
Txn
public Txn() -
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<Comment> commentList) Create a Txn value object with the given parameters.- Parameters:
sub
- the submission entity (required)formDataMap
- the form data mapformXml
- the form XML datagroupNames
- the submission group namespropertyMap
- the submission propertyreceiptPdf
- the receipt PDF bytesfileAttachList
- the file attachments listdeliveryFuncs
- the transaction delivery functions
-
Txn
Create a unit testing Txn value object with the given fields.- Parameters:
fields
- the transaction entity fields (required)- Since:
- 5.1.4
-
-
Method Details
-
toString
-
getId
The transaction id (PK). -
getLinkedTxnId
The transaction linked id. -
getAttachmentsStatus
The attachment status [ Required | Optional | Completed ]. -
getFormStatusAbandoned
The abandonment form status.- Since:
- 23.10.0
-
isBillableFlag
public boolean isBillableFlag()The billable flag.- Since:
- 22.10
-
getOrgId
The organization id (PK). -
getClientCode
The organization code. -
getOrgName
The organization name. -
getDeliveryStatus
The delivery status [ Not Ready | Ready | Sent Email | In Progress | Pending | Completed | Error | Undeliverable | Not Required ]. -
getDeliveryChannel
The organization delivery channel name. -
getDeliveryMaxAttempts
The delivery max attempts. -
getDeliveryMessage
The delivery message. -
getDeliveryMethod
The delivery method [ Email | Email Secure | Delivery Process | REST Service | Web Service ]. -
getDeliveryProcessAttempts
The delivery process attempts. -
getEmailAddress
The contact email address. -
getEmailVerificationStatus
The email verification status for forms configured with anonymous email verification.- Since:
- 19.11.3
-
getFormId
The form id (PK). -
getFormCode
The form code, globally unique identifier. -
getFormName
The form name. -
getFormStatus
The transaction form status [ Assigned | Opened | Saved | Submitted | Completed | Expired | Abandoned ]. -
getFormType
The transaction form type [ Composer SmartForm | Maestro Form | JS App, Static PDF Form | Other Document].- Since:
- 21.5.0
-
getGroupNames
The transaction group names. -
getPaymentStatus
The transaction payment status [ Required | Completed | Error | Pending ]. -
getPaymentTotal
The transaction payment total. -
getJobId
The job id. -
getJobActionId
The job action id. -
getJobRefNumber
The job reference number. -
getSpaceId
The form space id (PK). -
getSpaceName
The form space name. -
getReceiptNumber
The transaction receipt number. -
getReceiptStatus
The transaction PDF receipt generation status [ Ready | In Progress | Completed | Error | Error No Data ]. -
getSaveChallengeFailures
The save challenge failures- Since:
- 21.5.0
-
getSaveChallengeHash
The save challenge hash- Since:
- 5.1.0
-
getSaveChallengeLastFailure
The save challenge last failure- Since:
- 21.5.0
-
getSaveChallengeTimeout
The save challenge timeout- Since:
- 5.1.0
-
getTimeCreated
The time the transaction was created. -
getTimeAbandoned
The time the transaction was abandoned. -
getTimeUserLastModified
The time the user last modified the transaction. -
getTimeSubmitted
The time the transaction was submitted. -
getTimeAbandonmentScheduled
The time the transaction was scheduled for abandonment.- Since:
- 19.11.0
-
getTimeCompleted
The time the transaction was completed. -
getTimeDelivered
The time the transaction was delivered. -
getTimeProcessUpdated
The time the processing status was last updated. -
getTimeSubmissionExpiry
Deprecated.usegetTimeTxnExpiry()
insteadThe time the submission will expire. -
getTimeTaskExpiry
The time the task will expiry. -
getTimeTaskScheduled
The time the task was scheduled to be completed. -
isDataDeleted
public boolean isDataDeleted()The transaction user PII data has been deleted. -
getSubmitKey
The transaction submit key, globally unique id (GUID). -
getTrackingCode
The transaction tracking code. -
getTransRefNumber
The transaction ref number.- Since:
- 18.11.0
-
getUserLoginName
The transaction users login name (username). -
getCreatedBy
The transaction created by username.- Since:
- 23.10.0
-
isUserSaved
public boolean isUserSaved()The transaction is user saved.- Since:
- 5.0.3
-
getExternalUserId
The transaction external user id. -
getPaymentGatewayTimestamp
The payment gateway timestamp. -
getPaymentGatewayReceiptNo
The payment gateway receipt number. -
getPaymentGatewayTxnNo
The payment gateway transaction number. -
getProcessStatus
The transaction processing status. -
getFormVersionId
The form version id (PK). -
getFormVersionNumber
The form version number. -
getTxnScore
The transaction score. -
getUserAgent
The HTTP user agent header.- Since:
- 18.11.0
-
getUserAgentDeviceType
The HTTP user agent device type [ Phone | Tablet | Desktop | Game Console | Unknown ].- Since:
- 18.11.0
-
getFormAbandonmentType
The type of form abandonment [ Bounced | Started | Cancelled | Submitted | Saved ]. -
getFormUrl
The form URL if the transaction has not been completed. -
getReceiptUrl
The receipt URL if the transaction has not been completed. -
getCheckpoints
The list of transaction delivery checkpoints. -
getFormDataMap
The form data map (data extracts). -
getPropertyMap
The property map (transaction properties). -
getMilestones
The list of transaction milestones. -
getFormXml
The form XML data. -
getReceiptPdf
public byte[] getReceiptPdf()The receipt PDF bytes. -
getFileAttachList
The file attachments list. -
getDeliveryFuncs
The transaction delivery functions list. -
getTimePurgeDataScheduled
The time the transaction PII data is scheduled to be purged.- Since:
- 19.11.3
-
getTimePurgeDataActual
The actual time the transaction PII data was purged.- Since:
- 19.11.3
-
getTimePurgeRecordScheduled
The time the transaction record is scheduled to be purged.- Since:
- 19.11.3
-
getTimeRequested
The time the transaction was requested.- Since:
- 19.11.3
-
isTaskUserDeletableFlag
public boolean isTaskUserDeletableFlag()The task user deletable flag.- Since:
- 23.10.0
-
getTaskKey
The task key.- Since:
- 23.10.0
-
getTaskSubject
The task subject.- Since:
- 23.10.0
-
getTimeTaskCreated
The time task was created.- Since:
- 23.10.0
-
getTaskAddress
The task address.- Since:
- 23.10.0
-
getTasklongitude
The task longitude.- Since:
- 23.10.0
-
getTasklatitude
The task latitude.- Since:
- 23.10.0
-
getTimeTxnExpiry
The time the txn will expire.- Since:
- 19.11.3
-
getComments
Deprecated.usegetCommentList()
The Workspaces comments- Since:
- 19.11.3
-
getCommentList
The txn comments- Since:
- 21.5.0
-
getCommentList()