Class FileAttach


  • public class FileAttach
    extends java.lang.Object
    Provide a Transaction File Attachment value object class.
    Since:
    5.0.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String attachKey
      The required attachment key.
      java.lang.String attachName
      The required attachment name.
      java.lang.String contentType
      The file attachment content type.
      java.lang.Boolean dataDeleted
      The file attachment data has been deleted.
      byte[] fileData
      The attachment file data.
      java.lang.String fileDataHash
      The attachment file data hash (SHA256).
      java.lang.String fileName
      The attachment file name.
      java.lang.Long fileSize
      The attachment file data size in bytes.
      java.lang.Long id
      The attachment id (PK).
      java.lang.String submitMethod
      The attachment submission method [ Electronic | Manual ].
      java.util.Date timeUploaded
      The time the attachment was uploaded.
      java.lang.String userDesc
      The user description.
      java.lang.String userLoginName
      The user login name (username).
      java.lang.String virusStatus
      The virus scan status.
    • Constructor Summary

      Constructors 
      Constructor Description
      FileAttach​(com.avoka.fc.core.entity.Attachment attachment)
      Create a file attachment value object.
      FileAttach​(java.lang.String attachmentName, java.lang.String fileName, byte[] fileData)
      Create a file attachment value object with the given attachment name, file name and file data.
      FileAttach​(java.lang.String attachmentName, java.lang.String fileName, byte[] fileData, java.lang.String userDescription)
      Create a file attachment value object with the given attachment name, file name, file data and user description.
      FileAttach​(java.util.Map fields)
      Create a unit testing FileAttach value object with the given fields.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • id

        public final java.lang.Long id
        The attachment id (PK).
      • attachKey

        public final java.lang.String attachKey
        The required attachment key.
      • attachName

        public final java.lang.String attachName
        The required attachment name.
      • submitMethod

        public final java.lang.String submitMethod
        The attachment submission method [ Electronic | Manual ].
      • dataDeleted

        public final java.lang.Boolean dataDeleted
        The file attachment data has been deleted.
      • fileName

        public final java.lang.String fileName
        The attachment file name.
      • fileData

        public final byte[] fileData
        The attachment file data.
      • fileDataHash

        public final java.lang.String fileDataHash
        The attachment file data hash (SHA256).
      • fileSize

        public final java.lang.Long fileSize
        The attachment file data size in bytes.
      • timeUploaded

        public final java.util.Date timeUploaded
        The time the attachment was uploaded.
      • contentType

        public final java.lang.String contentType
        The file attachment content type.
      • userDesc

        public final java.lang.String userDesc
        The user description.
      • userLoginName

        public final java.lang.String userLoginName
        The user login name (username).
      • virusStatus

        public final java.lang.String virusStatus
        The virus scan status.
    • Constructor Detail

      • FileAttach

        public FileAttach​(com.avoka.fc.core.entity.Attachment attachment)
        Create a file attachment value object.
        Parameters:
        attachment - the transaction attachment entity (required)
      • FileAttach

        public FileAttach​(java.lang.String attachmentName,
                          java.lang.String fileName,
                          byte[] fileData,
                          java.lang.String userDescription)
        Create a file attachment value object with the given attachment name, file name, file data and user description.
        Parameters:
        attachmentName - the required attachment name (required)
        fileName - the file name of the attachment (required)
        fileData - the attachment file data (required)
        userDescription - the user description of the file attachment (optional)
      • FileAttach

        public FileAttach​(java.lang.String attachmentName,
                          java.lang.String fileName,
                          byte[] fileData)
        Create a file attachment value object with the given attachment name, file name and file data.
        Parameters:
        attachmentName - the required attachment name (required)
        fileName - the file name of the attachment (required)
        fileData - the attachment file data (required)
      • FileAttach

        public FileAttach​(java.util.Map fields)
        Create a unit testing FileAttach value object with the given fields.
        Parameters:
        fields - the submission entity fields (required)
        Since:
        5.1.4
    • Method Detail

      • toString

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