Package com.avoka.tm.vo
Class Txn
- java.lang.Object
-
- com.avoka.tm.vo.Txn
-
public class Txn extends Object
Provide a Transaction value object class.- Since:
- 5.0.0
-
-
Field Summary
Fields Modifier and Type Field Description 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.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.static String
FORM_TYPE_JS_APP
The "JS App" form typestatic String
FORM_TYPE_MAESTRO_FORM
The "Maestro Form" form typestatic String
FORM_TYPE_OTHER_DOCUMENT
The "Other Document" form typestatic String
FORM_TYPE_STATIC_PDF_FORM
The "Static PDF Form" form type
-
Constructor Summary
Constructors Constructor Description Txn()
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.Txn(Map fields)
Create a unit testing Txn value object with the given fields.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
getAttachmentsStatus()
The attachment status [ Required | Optional | Completed ].List<TxnCheckpoint>
getCheckpoints()
The list of transaction delivery checkpoints.String
getClientCode()
The organization code.List<Comment>
getCommentList()
The txn commentsList<Map<String,String>>
getComments()
Deprecated.usegetCommentList()
String
getDeliveryChannel()
The organization delivery channel name.List<TxnDeliveryFunc>
getDeliveryFuncs()
The transaction delivery functions list.Integer
getDeliveryMaxAttempts()
The delivery max attempts.String
getDeliveryMessage()
The delivery message.String
getDeliveryMethod()
The delivery method [ Email | Email Secure | Delivery Process | REST Service | Web Service ].Integer
getDeliveryProcessAttempts()
The delivery process attempts.String
getDeliveryStatus()
The delivery status [ Not Ready | Ready | Sent Email | In Progress | Pending | Completed | Error | Undeliverable | Not Required ].String
getEmailAddress()
The contact email address.String
getEmailVerificationStatus()
The email verification status for forms configured with anonymous email verification.String
getExternalUserId()
The transaction external user id.List<FileAttach>
getFileAttachList()
The file attachments list.String
getFormAbandonmentType()
The type of form abandonment [ Bounced | Started | Cancelled | Submitted | Saved ].String
getFormCode()
The form code, globally unique identifier.Map<String,String>
getFormDataMap()
The form data map (data extracts).Long
getFormId()
The form id (PK).String
getFormName()
The form name.String
getFormStatus()
The transaction form status [ Assigned | Opened | Saved | Submitted | Completed | Expired | Abandoned ].String
getFormType()
The transaction form type [ Composer SmartForm | Maestro Form | JS App, Static PDF Form | Other Document].String
getFormUrl()
The form URL if the transaction has not been completed.Long
getFormVersionId()
The form version id (PK).String
getFormVersionNumber()
The form version number.String
getFormXml()
The form XML data.Set<String>
getGroupNames()
The transaction group names.Long
getId()
The transaction id (PK).Long
getJobActionId()
The job action id.Long
getJobId()
The job id.String
getJobRefNumber()
The job reference number.List<String>
getMilestones()
The list of transaction milestones.Long
getOrgId()
The organization id (PK).String
getOrgName()
The organization name.String
getPaymentGatewayReceiptNo()
The payment gateway receipt number.Date
getPaymentGatewayTimestamp()
The payment gateway timestamp.Long
getPaymentGatewayTxnNo()
The payment gateway transaction number.String
getPaymentStatus()
The transaction payment status [ Required | Completed | Error | Pending ].Double
getPaymentTotal()
The transaction payment total.String
getProcessStatus()
The transaction processing status.Map<String,String>
getPropertyMap()
The property map (transaction properties).String
getReceiptNumber()
The transaction receipt number.byte[]
getReceiptPdf()
The receipt PDF bytes.String
getReceiptStatus()
The transaction PDF receipt generation status [ Ready | In Progress | Completed | Error | Error No Data ].String
getReceiptUrl()
The receipt URL if the transaction has not been completed.Integer
getSaveChallengeFailures()
The save challenge failuresString
getSaveChallengeHash()
The save challenge hashDate
getSaveChallengeLastFailure()
The save challenge last failureDate
getSaveChallengeTimeout()
The save challenge timeoutLong
getSpaceId()
The form space id (PK).String
getSpaceName()
The form space name.String
getSubmitKey()
The transaction submit key, globally unique id (GUID).Date
getTimeAbandoned()
The time the transaction was abandoned.Date
getTimeAbandonmentScheduled()
The time the transaction was scheduled for abandonment.Date
getTimeCompleted()
The time the transaction was completed.Date
getTimeCreated()
The time the transaction was created.Date
getTimeDelivered()
The time the transaction was delivered.Date
getTimeProcessUpdated()
The time the processing status was last updated.Date
getTimePurgeDataActual()
The actual time the transaction PII data was purged.Date
getTimePurgeDataScheduled()
The time the transaction PII data is scheduled to be purged.Date
getTimePurgeRecordScheduled()
The time the transaction record is scheduled to be purged.Date
getTimeRequested()
The time the transaction was requested.Date
getTimeSubmissionExpiry()
Deprecated.usegetTimeTxnExpiry()
insteadDate
getTimeSubmitted()
The time the transaction was submitted.Date
getTimeTaskExpiry()
The time the task will expiry.Date
getTimeTaskScheduled()
The time the task was scheduled to be completed.Date
getTimeTxnExpiry()
The time the txn will expire.Date
getTimeUserLastModified()
The time the user last modified the transaction.String
getTrackingCode()
The transaction tracking code.String
getTransRefNumber()
The transaction ref number.Integer
getTxnScore()
The transaction score.String
getUserAgent()
The HTTP user agent header.String
getUserAgentDeviceType()
The HTTP user agent device type [ Phone | Tablet | Desktop | Game Console | Unknown ].String
getUserLoginName()
The transaction users login name (username).boolean
isDataDeleted()
The transaction user PII data has been deleted.boolean
isUserSaved()
The transaction is user saved.String
toString()
-
-
-
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
-
FORM_TYPE_JS_APP
public static final String FORM_TYPE_JS_APP
The "JS App" form type- Since:
- 21.5.0
- See Also:
- Constant Field Values
-
FORM_TYPE_MAESTRO_FORM
public static final String FORM_TYPE_MAESTRO_FORM
The "Maestro Form" form type- Since:
- 21.5.0
- See Also:
- Constant Field Values
-
FORM_TYPE_STATIC_PDF_FORM
public static final String FORM_TYPE_STATIC_PDF_FORM
The "Static PDF Form" form type- Since:
- 21.5.0
- See Also:
- Constant Field Values
-
FORM_TYPE_OTHER_DOCUMENT
public static final String FORM_TYPE_OTHER_DOCUMENT
The "Other Document" form type- Since:
- 21.5.0
- 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
-
-
Constructor Detail
-
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
public Txn(Map fields)
Create a unit testing Txn value object with the given fields.- Parameters:
fields
- the transaction entity fields (required)- Since:
- 5.1.4
-
-
Method Detail
-
toString
public String toString()
-
getId
public Long getId()
The transaction id (PK).
-
getAttachmentsStatus
public String getAttachmentsStatus()
The attachment status [ Required | Optional | Completed ].
-
getOrgId
public Long getOrgId()
The organization id (PK).
-
getClientCode
public String getClientCode()
The organization code.
-
getOrgName
public String getOrgName()
The organization name.
-
getDeliveryStatus
public String getDeliveryStatus()
The delivery status [ Not Ready | Ready | Sent Email | In Progress | Pending | Completed | Error | Undeliverable | Not Required ].
-
getDeliveryChannel
public String getDeliveryChannel()
The organization delivery channel name.
-
getDeliveryMaxAttempts
public Integer getDeliveryMaxAttempts()
The delivery max attempts.
-
getDeliveryMessage
public String getDeliveryMessage()
The delivery message.
-
getDeliveryMethod
public String getDeliveryMethod()
The delivery method [ Email | Email Secure | Delivery Process | REST Service | Web Service ].
-
getDeliveryProcessAttempts
public Integer getDeliveryProcessAttempts()
The delivery process attempts.
-
getEmailAddress
public String getEmailAddress()
The contact email address.
-
getEmailVerificationStatus
public String getEmailVerificationStatus()
The email verification status for forms configured with anonymous email verification.- Since:
- 19.11.3
-
getFormId
public Long getFormId()
The form id (PK).
-
getFormCode
public String getFormCode()
The form code, globally unique identifier.
-
getFormName
public String getFormName()
The form name.
-
getFormStatus
public String getFormStatus()
The transaction form status [ Assigned | Opened | Saved | Submitted | Completed | Expired | Abandoned ].
-
getFormType
public String getFormType()
The transaction form type [ Composer SmartForm | Maestro Form | JS App, Static PDF Form | Other Document].- Since:
- 21.5.0
-
getPaymentStatus
public String getPaymentStatus()
The transaction payment status [ Required | Completed | Error | Pending ].
-
getPaymentTotal
public Double getPaymentTotal()
The transaction payment total.
-
getJobId
public Long getJobId()
The job id.
-
getJobActionId
public Long getJobActionId()
The job action id.
-
getJobRefNumber
public String getJobRefNumber()
The job reference number.
-
getSpaceId
public Long getSpaceId()
The form space id (PK).
-
getSpaceName
public String getSpaceName()
The form space name.
-
getReceiptNumber
public String getReceiptNumber()
The transaction receipt number.
-
getReceiptStatus
public String getReceiptStatus()
The transaction PDF receipt generation status [ Ready | In Progress | Completed | Error | Error No Data ].
-
getSaveChallengeFailures
public Integer getSaveChallengeFailures()
The save challenge failures- Since:
- 21.5.0
-
getSaveChallengeHash
public String getSaveChallengeHash()
The save challenge hash- Since:
- 5.1.0
-
getSaveChallengeLastFailure
public Date getSaveChallengeLastFailure()
The save challenge last failure- Since:
- 21.5.0
-
getSaveChallengeTimeout
public Date getSaveChallengeTimeout()
The save challenge timeout- Since:
- 5.1.0
-
getTimeCreated
public Date getTimeCreated()
The time the transaction was created.
-
getTimeAbandoned
public Date getTimeAbandoned()
The time the transaction was abandoned.
-
getTimeUserLastModified
public Date getTimeUserLastModified()
The time the user last modified the transaction.
-
getTimeSubmitted
public Date getTimeSubmitted()
The time the transaction was submitted.
-
getTimeAbandonmentScheduled
public Date getTimeAbandonmentScheduled()
The time the transaction was scheduled for abandonment.- Since:
- 19.11.0
-
getTimeCompleted
public Date getTimeCompleted()
The time the transaction was completed.
-
getTimeDelivered
public Date getTimeDelivered()
The time the transaction was delivered.
-
getTimeProcessUpdated
public Date getTimeProcessUpdated()
The time the processing status was last updated.
-
getTimeSubmissionExpiry
@Deprecated public Date getTimeSubmissionExpiry()
Deprecated.usegetTimeTxnExpiry()
insteadThe time the submission will expire.
-
getTimeTaskExpiry
public Date getTimeTaskExpiry()
The time the task will expiry.
-
getTimeTaskScheduled
public Date getTimeTaskScheduled()
The time the task was scheduled to be completed.
-
isDataDeleted
public boolean isDataDeleted()
The transaction user PII data has been deleted.
-
getSubmitKey
public String getSubmitKey()
The transaction submit key, globally unique id (GUID).
-
getTrackingCode
public String getTrackingCode()
The transaction tracking code.
-
getTransRefNumber
public String getTransRefNumber()
The transaction ref number.- Since:
- 18.11.0
-
getUserLoginName
public String getUserLoginName()
The transaction users login name (username).
-
isUserSaved
public boolean isUserSaved()
The transaction is user saved.- Since:
- 5.0.3
-
getExternalUserId
public String getExternalUserId()
The transaction external user id.
-
getPaymentGatewayTimestamp
public Date getPaymentGatewayTimestamp()
The payment gateway timestamp.
-
getPaymentGatewayReceiptNo
public String getPaymentGatewayReceiptNo()
The payment gateway receipt number.
-
getPaymentGatewayTxnNo
public Long getPaymentGatewayTxnNo()
The payment gateway transaction number.
-
getProcessStatus
public String getProcessStatus()
The transaction processing status.
-
getFormVersionId
public Long getFormVersionId()
The form version id (PK).
-
getFormVersionNumber
public String getFormVersionNumber()
The form version number.
-
getTxnScore
public Integer getTxnScore()
The transaction score.
-
getUserAgent
public String getUserAgent()
The HTTP user agent header.- Since:
- 18.11.0
-
getUserAgentDeviceType
public String getUserAgentDeviceType()
The HTTP user agent device type [ Phone | Tablet | Desktop | Game Console | Unknown ].- Since:
- 18.11.0
-
getFormAbandonmentType
public String getFormAbandonmentType()
The type of form abandonment [ Bounced | Started | Cancelled | Submitted | Saved ].
-
getFormUrl
public String getFormUrl()
The form URL if the transaction has not been completed.
-
getReceiptUrl
public String getReceiptUrl()
The receipt URL if the transaction has not been completed.
-
getCheckpoints
public List<TxnCheckpoint> getCheckpoints()
The list of transaction delivery checkpoints.
-
getPropertyMap
public Map<String,String> getPropertyMap()
The property map (transaction properties).
-
getFormXml
public String getFormXml()
The form XML data.
-
getReceiptPdf
public byte[] getReceiptPdf()
The receipt PDF bytes.
-
getFileAttachList
public List<FileAttach> getFileAttachList()
The file attachments list.
-
getDeliveryFuncs
public List<TxnDeliveryFunc> getDeliveryFuncs()
The transaction delivery functions list.
-
getTimePurgeDataScheduled
public Date getTimePurgeDataScheduled()
The time the transaction PII data is scheduled to be purged.- Since:
- 19.11.3
-
getTimePurgeDataActual
public Date getTimePurgeDataActual()
The actual time the transaction PII data was purged.- Since:
- 19.11.3
-
getTimePurgeRecordScheduled
public Date getTimePurgeRecordScheduled()
The time the transaction record is scheduled to be purged.- Since:
- 19.11.3
-
getTimeRequested
public Date getTimeRequested()
The time the transaction was requested.- Since:
- 19.11.3
-
getTimeTxnExpiry
public Date getTimeTxnExpiry()
The time the txn will expire.- Since:
- 19.11.3
-
getComments
@Deprecated(since="21.5.0") public List<Map<String,String>> getComments()
Deprecated.usegetCommentList()
The Workspaces comments- Since:
- 19.11.3
-
-