Class FileAttach


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

      • id

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

        public final String attachKey
        The required attachment key.
      • attachName

        public final String attachName
        The required attachment name.
      • submitMethod

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

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

        public final String fileName
        The attachment file name.
      • fileData

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

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

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

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

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

        public final String userDesc
        The user description.
      • userLoginName

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

        public final 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​(String attachmentName,
                          String fileName,
                          byte[] fileData,
                          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​(String attachmentName,
                          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​(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 String toString()
        Overrides:
        toString in class Object
        Returns:
        a string representation of the object.
      • getId

        public Long getId()
        The attachment id (PK).
      • getAttachKey

        public String getAttachKey()
        The required attachment key.
      • getAttachName

        public String getAttachName()
        The required attachment name.
      • getSubmitMethod

        public String getSubmitMethod()
        The attachment submission method [ Electronic | Manual ].
      • getDataDeleted

        public Boolean getDataDeleted()
        The file attachment data has been deleted.
      • getFileName

        public String getFileName()
        The attachment file name.
      • getFileData

        public byte[] getFileData()
        The attachment file data.
      • getFileDataHash

        public String getFileDataHash()
        The attachment file data hash (SHA256).
      • getFileSize

        public Long getFileSize()
        The attachment file data size in bytes.
      • getTimeUploaded

        public Date getTimeUploaded()
        The time the attachment was uploaded.
      • getContentType

        public String getContentType()
        The file attachment content type.
      • getUserDesc

        public String getUserDesc()
        The user description.
      • getUserLoginName

        public String getUserLoginName()
        The user login name (username).
      • getVirusStatus

        public String getVirusStatus()
        The virus scan status.