Package com.avoka.tm.vo

Class Form

  • public class Form
extends Object
    Provide a Form value object class.
    Since:
    5.0.0

    • Field Detail

      • id

        public final Long id
        The form id (PK).

      • formCode

        public final String formCode
        The form code.

      • formName

        public final String formName
        The form name.

      • orgId

        public final Long orgId
        The organization client id (PK).

      • formVersionId

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

      • description

        public final String description
        The current form versions description property.

      • groupNames

        public final Set<String> groupNames
        The set of associated form group group names.

      • spaceNames

        public final Set<String> spaceNames
        The set of associated space names.

      • submissionExpiryDate

        @Deprecated(since="19.11.0")
public final Date submissionExpiryDate
        Deprecated.
        use txnExpiryDate instead
        The date after which all submissions for this form will expire.
        Since:
        19.5.0

      • submissionExpiryDays

        @Deprecated(since="19.11.0")
public final Integer submissionExpiryDays
        Deprecated.
        use txnExpiryDays instead
        The number of days after which a submission will expire.
        Since:
        19.5.0

      • txnExpiryDate

        public final Date txnExpiryDate
        The date after which all transactions for this form will expire.
        Since:
        19.11.0

      • txnExpiryDays

        public final Integer txnExpiryDays
        The number of days after which a transaction will expire.
        Since:
        19.5.0

      • versions

        public final Set<String> versions
        The set of associated versions.
        Since:
        5.1.0

    • Constructor Detail

      • Form

        public Form​(com.avoka.fc.core.entity.Form form)
        Create a Form value object with the given form entity parameter.
        Parameters:
        form - the form entity parameter (required)

      • Form

        public Form​(Map fields)
        Create a unit testing Form value object with the given fields.
        Parameters:
        fields - the form 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.

      • getId

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

      • getFormCode

        public String getFormCode()
        The form code.

      • getFormName

        public String getFormName()
        The form name.

      • getOrgId

        public Long getOrgId()
        The organization client id (PK).

      • getFormVersionId

        public Long getFormVersionId()
        The current form version id (PK).

      • getDescription

        public String getDescription()
        The current form versions description property.

      • getGroupNames

        public Set<String> getGroupNames()
        The set of associated form group group names.

      • getSpaceNames

        public Set<String> getSpaceNames()
        The set of associated space names.

      • getSubmissionExpiryDate

        @Deprecated(since="19.11.3")
public Date getSubmissionExpiryDate()
        Deprecated.
        use getTxnExpiryDate() instead
        The date after which all submissions for this form will expire.
        Since:
        19.5.0

      • getSubmissionExpiryDays

        @Deprecated(since="19.11.3")
public Integer getSubmissionExpiryDays()
        Deprecated.
        use getTxnExpiryDays() instead
        The number of days after which a submission will expire.
        Since:
        19.5.0

      • getTxnExpiryDate

        public Date getTxnExpiryDate()
        The date after which all submissions for this form will expire.
        Since:
        19.11.3

      • getTxnExpiryDays

        public Integer getTxnExpiryDays()
        The number of days after which a submission will expire.
        Since:
        19.11.3

      • getVersions

        public Set<String> getVersions()
        The set of associated versions.
        Since:
        5.1.0