Class Attachment

java.lang.Object
de.xima.cmn.dao.model.AEntity<Long>
de.xima.fc.entities.AbstractEntity
de.xima.fc.entities.AbstractLockableEntity
de.xima.fc.entities.ALockableEntity
de.xima.fc.entities.Attachment
All Implemented Interfaces:
de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, IFileProviding<AttachmentDatei, AttachmentDateiData>, ILockingVersionProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUncacheableDatei, IUncacheableFile, IUUIDEntity, IVorgangDependent, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>
@Entity public class Attachment extends ALockableEntity implements IFileProviding<AttachmentDatei, AttachmentDateiData>, IVorgangDependent, IUncacheableFile, IUUIDEntity
Die Klasse Attachment beinhaltet Meta-Informationen zu einem im System verfügbaren Anhang. Dieser Anhang kann zum einen eine Datei sein, die in einem Formular hochgeladen wurde, zum andern kann es sich um eine Datei handeln, die von einem 'Postfachbearbeiter' einem Vorgang angefügt wurde.
Author:
XIMA MEDIA GmbH
See Also:

  • Field Details

  • Constructor Details

    • Attachment

      public Attachment()

  • Method Details

    • getId

      public Long getId()
      Specified by:
      getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

    • setId

      public void setId(Long id)
      Description copied from class: AbstractEntity
      !!!WARNING: Currently values bigger Integer.MAX_VALUE or lower then Integer.MIN_VALUE will be altered to null!!!
      Specified by:
      setId in interface de.xima.cmn.dao.interfaces.IEntity<Long>
      Overrides:
      setId in class AbstractEntity
      Parameters:
      id - Long the database-id to set

    • getUUID

      public String getUUID()
      Description copied from interface: IUUIDEntity
      Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.
      Specified by:
      getUUID in interface IUUIDEntity
      Returns:
      The UUID of the entity.

    • setUUID

      public void setUUID(String uuid)
      Description copied from interface: IUUIDEntity
      Sets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.
      Specified by:
      setUUID in interface IUUIDEntity
      Parameters:
      uuid - The UUID of the entity.

    • getUUIDObject

      public UUID getUUIDObject()
      Description copied from interface: IUUIDEntity
      Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.
      Specified by:
      getUUIDObject in interface IUUIDEntity
      Returns:
      The UUID of the entity.

    • setUUIDObject

      public void setUUIDObject(UUID uuid)

    • getVorgang

      public Vorgang getVorgang()
      Diese Methode dient dazu, den Vorgang zu ermitteln, zu dem das Attachment hinzugefügt wurde
      Specified by:
      getVorgang in interface IVorgangDependent
      Returns:
      Vorgangs-Instanz

    • setVorgang

      public void setVorgang(Vorgang vorgang)
      Diese Methode dient dazu, den Vorgang zu setzten, zu dem das Attachment zugehörig ist (Bedingung: nicht null).
      Parameters:
      vorgang - - Vorgang-Objekt

    • cloneBasics

      public Attachment cloneBasics()
      Returns:
      A copy of this entity with all fields copied that do not reference other entities. The getUUIDObject() is not copied.

    • getBenutzer

      public String getBenutzer()
      Diese Methode dient dazu, eine Zeichenkette zu erhalten, die Schlussfolgerungen auf den Ersteller dieses Attachments zulässt
      Returns:
      Nutzerkennung oder Nutzername

    • getUploadDatum

      public Date getUploadDatum()
      Diese Methode dient dazu, das Datum zu setzen, an welchem das Attachment hochgeladen wurde
      Returns:
      Date-Objekt oder null

    • getDateiName

      public String getDateiName()
      Diese Methode dient dazu, den Namen des Attachment zu erhalten
      Returns:
      Zeichenkette mit dem Dateinamen

    • getElementName

      public String getElementName()
      Diese Methode dient dazu, den Formularelementnamen zu erhalten, in welchem das Attachment angebenen wurde
      Returns:
      Zeichenkette mit dem Elementnamen oder null

    • setElementName

      public void setElementName(String elementName)
      Diese Methode dient dazu, den Formularelementnamen zu setzen
      Parameters:
      elementName - - Zeichenkette für den Elementnamen oder null

    • isLoeschbar

      public boolean isLoeschbar()
      Attachments sind dann löschbar, wenn der zugehörige Vorgang löschbar ist (Vorgänge sind löschbar, wenn der Status, in dem sie sich befinden, das Löschen von Vorgängen erlaubt).
      Returns:
      true, wenn dieses Attachment löschbar ist, ansonsten false.
      See Also:

    • getFileEntity

      public AttachmentDatei getFileEntity()
      Specified by:
      getFileEntity in interface IFileProviding<AttachmentDatei, AttachmentDateiData>

    • setFileEntity

      public void setFileEntity(AttachmentDatei fileEntity)
      Specified by:
      setFileEntity in interface IFileProviding<AttachmentDatei, AttachmentDateiData>

    • getFormEingang

      public FormEingang getFormEingang()
      Optional. The form record data from the submission that created this attachment. Available only if the attachment was created by an upload from an HTML input file element. When the attachment got created in other manners (such as by a workflow action or manually in the inbox), this will be null.

      Note: This feature was disabled in the past and got enabled again starting with version 8.2.0. For form records created by older versions of formcycle, this field will be null even for attachments from form uploads.

      Returns:
      The form record data from the form submission where this attachment was created.

    • setFormEingang

      public void setFormEingang(FormEingang formRecordData)
      Optional. The form record data from the submission that created this attachment. Available only if the attachment was created by an upload from an HTML input file element. When the attachment got created in other manners (such as by a workflow action or manually in the inbox), this will be null.

      Note: This feature was disabled in the past and got enabled again starting with version 8.2.0. For form records created by older versions of formcycle, this field will be null even for attachments from form uploads.

      Parameters:
      formRecordData - The form record data from the form submission where this attachment was created.

    • getSource

      public EAttachmentSource getSource()

    • setSource

      public void setSource(EAttachmentSource source)

    • isAccessibleToEndUser

      public boolean isAccessibleToEndUser()

    • setAccessibleToEndUser

      public void setAccessibleToEndUser(boolean accessibleToEndUser)

    • getOriginalAttachment

      public Attachment getOriginalAttachment()
      Returns:
      the original (unconverted) attachment, if there's one (i.e. a conversion has been applied and the original attachment is configured to be kept) - null otherwise

    • setOriginalAttachment

      public void setOriginalAttachment(Attachment originalAttachment)

    • getUuid

      public String getUuid()
      Returns:
      uuid

    • setUuid

      public void setUuid(String uuid)
      Parameters:
      uuid - the uuid

    • getMandant

      @Deprecated public Mandant getMandant()
      Deprecated.
      will be removed, use getVorgang() and AClientDependentEntity.getMandant()
      Returns:
      returns the client or null if not set

    • setMandant

      @Deprecated public void setMandant(Mandant mandant)
      Deprecated.
      will be removed, use getVorgang() and AClientDependentEntity.setMandant(Mandant)

    • getOutputAlias

      @Deprecated public String getOutputAlias()
      Deprecated.
      will be removed. Currently returns the file name
      Returns:
      the output alias

    • setOutputAlias

      @Deprecated public void setOutputAlias(String outputAlias)
      Deprecated.
      will be removed. Currently an NO-OP method
      Parameters:
      outputAlias - the output alias to set