Package com.adobe.aemds.guide.model

Class FormSubmitInfo

  • All Implemented Interfaces:
    java.io.Serializable
    public class FormSubmitInfo
extends FormDataWrapper
    Defines the information required during form submission
    Since:
    6.3
    See Also:
    Serialized Form

    • Constructor Detail

      • FormSubmitInfo

        public FormSubmitInfo()

    • Method Detail

      • getFormContainerPath

        public java.lang.String getFormContainerPath()
        Returns the path to the form container
        Returns:
        path to the form container

      • setFormContainerPath

        public void setFormContainerPath​(java.lang.String formContainerPath)
        Sets the given form container path
        Parameters:
        formContainerPath - path to the form container

      • setData

        public void setData​(java.lang.String data)
        Sets the data submitted by the form
        Overrides:
        setData in class FormDataWrapper
        Parameters:
        data - data submitted

      • getDocumentOfRecord

        public FileAttachmentWrapper getDocumentOfRecord()
        Returns the document of record as a result of form submission. The DoR is always Non-Interactive
        Returns:
        FileAttachmentWrapper representing the document of record

      • setDocumentOfRecord

        public void setDocumentOfRecord​(FileAttachmentWrapper documentOfRecord)
        Sets the document of record as a result of form submission.
        Parameters:
        documentOfRecord - FileAttachmentWrapper representing the document of record

      • getFileAttachmentMap

        public java.lang.String getFileAttachmentMap()
        Returns the String representation of File Attachment map
        Returns:
        String representing File Attachment map

      • setFileAttachmentMap

        public void setFileAttachmentMap​(java.lang.String fileAttachmentMap)
        Sets the String representation of File Attachment map
        Parameters:
        fileAttachmentMap - String representing File Attachment map

      • getFormContainerResource

        public Resource getFormContainerResource()
        Returns the form container resource
        Returns:
        form container resource

      • setFormContainerResource

        public void setFormContainerResource​(Resource formContainerResource)
        Sets the form container resource
        Parameters:
        formContainerResource - resource to the form container

      • getLocale

        public java.lang.String getLocale()
        Returns the form locale
        Returns:
        form locale

      • setLocale

        public void setLocale​(java.lang.String locale)
        Sets the form locale
        Parameters:
        locale - form locale

      • getDraftId

        public java.lang.String getDraftId()
        Return the draftId, in case saved form is submitted
        Returns:
        draftId

      • setDraftId

        public void setDraftId​(java.lang.String draftId)
        Set the draftId, in case saved form is submitted
        Parameters:
        draftId - draftId of the form

      • getFormSubmitter

        public java.lang.String getFormSubmitter()
        Returns the id of the user who submitted the form
        Returns:
        id of the user

      • setFormSubmitter

        public void setFormSubmitter​(java.lang.String formSubmitter)
        Sets the user id of the user who submitted the form
        Parameters:
        formSubmitter - user id of the user

      • getSignData

        public byte[] getSignData()
        Returns the data (represented as byte array), filled by signers, while signing the form.
        Returns:
        byte[] - data filled by the signers

      • setSignData

        public void setSignData​(byte[] signData)
        Sets the data (represented as byte array), filled by signers, while signing the form.
        Parameters:
        signData - data (represented as byte array) filled by the signers

      • getAgreementId

        public java.lang.String getAgreementId()
        Returns the Adobe Sign Agreement ID, which is generated when the form is sent to signers for signing.
        Returns:
        String representing Adobe Sign Agreement ID

      • setAgreementId

        public void setAgreementId​(java.lang.String agreementId)
        Sets the Adobe Sign Agreement ID, which is generated when the form is sent to signers for signing.
        Parameters:
        agreementId - String representing Adobe Sign Agreement ID

      • getPortalRecordInfo

        public PortalRecordInfo getPortalRecordInfo()
        Returns the information related to form submission, in Forms Portal.
        Returns:
        PortalRecordInfo represents Forms Portal form submission info

      • setPortalRecordInfo

        public void setPortalRecordInfo​(PortalRecordInfo portalRecordInfo)
        Sets the information related to form submission, in Forms Portal.
        Parameters:
        portalRecordInfo - PortalRecordInfo represents Forms Portal form submission info