Package com.avoka.fc.forms.api

Class Attachment

  • public class Attachment
extends Object
    Provide a Attachment element for representing Form Submission file attachments.

    • Constructor Detail

      • Attachment

        public Attachment()

    • Method Detail

      • getAttachmentKey

        public String getAttachmentKey()
        Return the surrogate key used to uniquely identify the file attachment.
        Returns:
        a key used to identify the file attachment

      • setAttachmentKey

        public void setAttachmentKey​(String attachmentKey)
        Set the surrogate key used to uniquely identify the file attachment.
        Parameters:
        attachmentKey - the surrogate key used to identify the file attachment

      • getAttachmentName

        public String getAttachmentName()
        Return the attachment name.
        Returns:
        the currently configured attachment name

      • setAttachmentName

        public void setAttachmentName​(String attachmentName)
        Set the attachment name
        Parameters:
        attachmentName - the new attachment name

      • getDocumentCode

        public String getDocumentCode()
        Return the code identifying the document type associated with the attachment.
        Returns:
        the attachment document type code

      • setDocumentCode

        public void setDocumentCode​(String documentCode)
        Set the code identifying the document type associated with the attachment.
        Parameters:
        documentCode - the the attachment document type code

      • getDocumentTypeName

        public String getDocumentTypeName()
        Return the name identifying the document type associated with the attachment.
        Returns:
        the attachment document type name

      • setDocumentTypeName

        public void setDocumentTypeName​(String documentTypeName)
        Set the name identifying the document type associated with the attachment.
        Parameters:
        documentTypeName - the the attachment document type name

      • getDescription

        public String getDescription()
        Return the attachment description.
        Returns:
        the attachment description

      • setDescription

        public void setDescription​(String description)
        Set the attachment description.
        Parameters:
        description - the attachment description

      • getFileBytes

        public byte[] getFileBytes()
        Return the attachment file content as a byte array.
        Returns:
        the attachment file content

      • setFileBytes

        public void setFileBytes​(byte[] fileBytes)
        Set the attachment file content as a byte array.
        Parameters:
        fileBytes - the new attachment file byte array

      • getFileName

        public String getFileName()
        Return the attachment file name.
        Returns:
        the attachment file name

      • setFileName

        public void setFileName​(String fileName)
        Set the attachment file name.
        Parameters:
        fileName - the attachment file name

      • isSubmittedManuallyFlag

        public boolean isSubmittedManuallyFlag()
        Return a flag indicating whether the user elected to submit their attachment manually. This means that they did not directly upload a file, but will deliver the attachment by other means (e.g. fax or mail).
        Returns:
        the submitted manually flag

      • setSubmittedManuallyFlag

        public void setSubmittedManuallyFlag​(boolean submittedManuallyFlag)
        Set a flag indicating whether the user elected to submit their attachment manually. This means that they did not directly upload a file, but will deliver the attachment by other means (e.g. fax or mail).
        Parameters:
        submittedManuallyFlag - the new value indicating whether the attachment will be submitted manually

      • isRequiredFlag

        public boolean isRequiredFlag()
        Return a flag indicating whether the attachment is mandatory or not. If an attachment is mandatory, the user has to attach a file or declare they will submit the attachment manually; otherwise, they cannot proceed with their submission.
        Returns:
        the required flag

      • setRequiredFlag

        public void setRequiredFlag​(boolean requiredFlag)
        Set a flag indicating whether the attachment is mandatory or not. If an attachment is mandatory, the user has to attach a file or declare they will submit the attachment manually; otherwise, they cannot proceed with their submission.
        Parameters:
        requiredFlag - the new value indicating whether the attachment is mandatory