Package com.avoka.fc.forms.api

Class Submission

  • public class Submission
extends Object
    Provides a form Submission element.

    • Constructor Detail

      • Submission

        public Submission()

    • Method Detail

      • getSubmissionKey

        public String getSubmissionKey()
        Return the submission surrogate key
        Returns:
        the current surrogate key

      • setSubmissionKey

        public void setSubmissionKey​(String submissionKey)
        Set the submission surrogate key
        Parameters:
        submissionKey - the new surrogate key

      • getSubmissionTime

        public long getSubmissionTime()
        Return the date and time of submission.
        Returns:
        the time of submission

      • setSubmissionTime

        public void setSubmissionTime​(long submissionTime)
        Set the date and time of submission.
        Parameters:
        submissionTime - the new time of submission

      • getFormName

        public String getFormName()
        Return the name of the form that was submitted.
        Returns:
        the form name

      • setFormName

        public void setFormName​(String formName)
        Set the name of the form that was submitted.
        Parameters:
        formName - the new form name

      • getFormCode

        public String getFormCode()
        Return the client form code of the form that was submitted.
        Returns:
        the form code

      • setFormCode

        public void setFormCode​(String formCode)
        Set the client form code of the form that was submitted.
        Parameters:
        formCode - the new form code

      • getFormDataBytes

        public byte[] getFormDataBytes()
        Return the submitted form data.
        Returns:
        a byte array representing the submitted XML data

      • setFormDataBytes

        public void setFormDataBytes​(byte[] formDataBytes)
        Set the submitted form data.
        Parameters:
        formDataBytes - a byte array representing the submitted XML data

      • getFormTemplateVersion

        public String getFormTemplateVersion()
        Return the version number that was used when submitting the form.
        Returns:
        the version number string of the template version used during submission.

      • setFormTemplateVersion

        public void setFormTemplateVersion​(String formTemplateVersion)
        Set the version number that was used when submitting the form.
        Parameters:
        formTemplateVersion - the version number string of the template version used during submission.

      • getPdfReceiptBytes

        public byte[] getPdfReceiptBytes()
        Return the PDF receipt data, generally a flattened copy of the form submission.
        Returns:
        a byte array containing the PDF receipt

      • setPdfReceiptBytes

        public void setPdfReceiptBytes​(byte[] pdfReceiptBytes)
        Set the PDF receipt data, generally a flattened copy of the form submission.
        Parameters:
        pdfReceiptBytes - a byte array containing the PDF receipt

      • getAttachmentKeys

        public ArrayList<String> getAttachmentKeys()
        Return the surrogate keys of all attachments that are associated with the submission.
        Returns:
        a list of surrogate keys

      • setAttachmentKeys

        public void setAttachmentKeys​(ArrayList<String> attachmentKeys)
        Set the surrogate keys of all attachments that are associated with the submission.
        Parameters:
        attachmentKeys - a list of surrogate keys

      • getAttachmentList

        public ArrayList<Attachment> getAttachmentList()
        Return all attachments that are associated with the submission.
        Returns:
        a list of attachments

      • setAttachmentList

        public void setAttachmentList​(ArrayList<Attachment> attachmentList)
        Set the attachments that are associated with the submission.
        Parameters:
        attachmentList - the new list of attachments

      • getSubmissionId

        public long getSubmissionId()
        Return the submission OID used in the FormCenter database.
        Returns:
        the current submission identifier

      • setSubmissionId

        public void setSubmissionId​(long submissionId)
        Set the submission OID used in the FormCenter database.
        Parameters:
        submissionId - the new submission identifier

      • getReceiptNumber

        public String getReceiptNumber()
        Return the receipt number assigned to the submission.
        Returns:
        the current receipt number

      • setReceiptNumber

        public void setReceiptNumber​(String receiptNumber)
        Set the receipt number assigned to the submission.
        Parameters:
        receiptNumber - the new receipt number