Class FormRecordMessageUploadRequest

java.lang.Object
de.xima.cmn.dao.model.AEntity<Long>
de.xima.fc.entities.AbstractEntity
de.xima.fc.entities.AbstractLockableEntity
de.xima.fc.entities.FormRecordMessageUploadRequest
All Implemented Interfaces:
de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, ILockingVersionProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>
@Entity public class FormRecordMessageUploadRequest extends AbstractLockableEntity implements IUUIDEntity
Entity representing (pending or fulfilled) upload requests for form record messages.
Since:
8.2.0
Author:
XIMA MEDIA GmbH
See Also:

  • Field Details

  • Constructor Details

    • FormRecordMessageUploadRequest

      public FormRecordMessageUploadRequest()

  • Method Details

    • getAttachments

      public List<Attachment> getAttachments()

    • setAttachments

      public void setAttachments(List<Attachment> attachments)

    • getFileMergeMode

      public EUploadRequestFileMergeMode getFileMergeMode()
      When getFormFieldName() is set: how to handle existing files of the upload element.
      Returns:
      How to handle existing files of the upload element.

    • setFileMergeMode

      public void setFileMergeMode(EUploadRequestFileMergeMode fileMergeMode)
      When getFormFieldName() is set: how to handle existing files of the upload element.
      Parameters:
      fileMergeMode - How to handle existing files of the upload element.

    • getFormFieldName

      public String getFormFieldName()
      The name of the form field that this upload request is associated with. When set and a file is uploaded, the files are associated with that upload element. Can be null when the upload request is not associated with an upload form field. See also getFileMergeMode().
      Returns:
      The name of the form field that this upload request is associated with.

    • setFormFieldName

      public void setFormFieldName(String formFieldName)
      The name of the form field that this upload request is associated with. When set and a file is uploaded, the files are associated with that upload element. Can be null when the upload request is not associated with an upload form field. See also getFileMergeMode().
      Parameters:
      formFieldName - The name of the form field that this upload request is associated with.

    • getId

      public Long getId()
      The database ID of this entity that uniquely identifies it in the system.
      Specified by:
      getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>
      Returns:
      The database ID of this entity.

    • getMessage

      public FormRecordMessage getMessage()
      Each upload request is associated with a message that contains details for the end user regarding the upload, e.g. what is wrong with the existing file.
      Returns:
      The message owning this upload request.

    • setMessage

      public void setMessage(FormRecordMessage message)
      Each upload request is associated with a message that contains details for the end user regarding the upload, e.g. what is wrong with the existing file.
      Parameters:
      message - The message owning this upload request.

    • getRepetitionId

      public Long getRepetitionId()
      When the getFormFieldName() refers to a repeated field, the repetition index of the field. When set, only the files for that repetition instance are changed when a file is uploaded. Note that the repetition index is not the ordinal index of the repetition, but a unique identifier. An ordinal index starts at 0 is continuous. An ID may be any unique value.
      Returns:
      The repetition index of the field.

    • setRepetitionId

      public void setRepetitionId(Long repetitionId)
      When the getFormFieldName() refers to a repeated field, the repetition index of the field. When set, only the files for that repetition instance are changed when a file is uploaded. Note that the repetition index is not the ordinal index of the repetition, but a unique identifier. An ordinal index starts at 0 is continuous. An ID may be any unique value.
      Parameters:
      repetitionId - The repetition index of the field.

    • getUUID

      public String getUUID()
      The UUID that identifies this upload request. The UUID is globally unique within the system.
      Specified by:
      getUUID in interface IUUIDEntity
      Returns:
      The UUID that identifies this upload request.

    • setUUID

      public void setUUID(String uuid)
      The UUID that identifies this upload request. The UUID is globally unique within the system. message.
      Specified by:
      setUUID in interface IUUIDEntity
      Parameters:
      uuid - The UUID that identifies this upload request.

    • getUUIDObject

      public UUID getUUIDObject()
      The UUID that identifies this upload request. The UUID is globally unique within the system. message.
      Specified by:
      getUUIDObject in interface IUUIDEntity
      Returns:
      The UUID that identifies this upload request.

    • setUUIDObject

      public void setUUIDObject(UUID uuid)
      The UUID that identifies this upload request. The UUID is globally unique within the system. message.
      Parameters:
      uuid - The UUID that identifies this upload request.

    • getUploadedInstant

      public Instant getUploadedInstant()
      The timestamp when the upload was fulfilled. null if the request is still pending and files were uploaded yet.
      Returns:
      The timestamp when the upload was fulfilled.

    • setUploadedInstant

      public void setUploadedInstant(Instant uploadedInstant)
      The timestamp when the upload was fulfilled. null if the request is still pending and files were uploaded yet.
      Parameters:
      uploadedInstant - The timestamp when the upload was fulfilled.

    • getUploaderAuthRef

      @Nullable public String getUploaderAuthRef()
      The universal reference ID to the user that uploaded the files. Is null if the upload is not yet fulfilled.
      Returns:
      The universal reference ID of the uploader.

    • setUploaderAuthRef

      public void setUploaderAuthRef(String uploaderAuthRef)
      Sets the universal reference ID to the user that uploaded the files.
      Parameters:
      uploaderAuthRef - The universal reference ID of the uploader.

    • getUploaderUserProfileUuid

      @Nullable public UUID getUploaderUserProfileUuid()
      The UUID of the user profile of the uploader. May be null if the user did not have a user profile. There might not exist a user profile anymore for this UUID.
      Returns:
      The UUID of the uploader's user profile.

    • setUploaderUserProfileUuid

      public void setUploaderUserProfileUuid(UUID uploaderUserProfileUuid)

    • isFulfilled

      public boolean isFulfilled()

    • isPending

      public boolean isPending()

    • removeAttachment

      public void removeAttachment(Attachment attachment)
      Removes the given attachment from the list of attachments, if such an attachment exists.
      Parameters:
      attachment - The attachment to remove.