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 Details

  • Constructor Details

    • Txn

      public Txn()

    • Txn

      public Txn(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 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 transaction entity fields (required)
      Since:
      5.1.4

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object
      Returns:
      a string representation of the object.

    • getId

      public Long getId()
      The transaction id (PK).

    • getLinkedTxnId

      public Long getLinkedTxnId()
      The transaction linked id.

    • getAttachmentsStatus

      public String getAttachmentsStatus()
      The attachment status [ Required | Optional | Completed ].

    • isBillableFlag

      public boolean isBillableFlag()
      The billable flag.
      Since:
      22.10

    • 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

    • getGroupNames

      public Set<String> getGroupNames()
      The transaction group names.

    • 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.
      use getTimeTxnExpiry() instead
      The 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.

    • getFormDataMap

      public Map<String,String> getFormDataMap()
      The form data map (data extracts).

    • getPropertyMap

      public Map<String,String> getPropertyMap()
      The property map (transaction properties).

    • getMilestones

      public List<String> getMilestones()
      The list of transaction milestones.

    • 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.
      use getCommentList()
      The Workspaces comments
      Since:
      19.11.3

    • getCommentList

      public List<Comment> getCommentList()
      The txn comments
      Since:
      21.5.0