Package ch.systemsx.cisd.openbis.generic.shared.api.v1.dto

Class Attachment

java.lang.Object
ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.Attachment
All Implemented Interfaces:
Serializable, Comparable<Attachment>
@JsonObject("Attachment") public class Attachment extends Object implements Serializable, Comparable<Attachment>
Immutable value object representing an attachment.
Since:
1.22
See Also:

  • Constructor Details

  • Method Details

    • getAttachmentHolderId

      public IObjectId getAttachmentHolderId()
      Returns the id of the entity holding this attachment. This will be the id which has been used to retrieve this attachment.

    • getFileName

      public String getFileName()
      Returns the file name of this attachment.

    • getVersion

      public int getVersion()
      Returns the version of this attachment. Starts with 1 and is increased by 1 whenever a user uploads a new version of the same file.

    • getTitle

      public String getTitle()
      Returns the title given by the user when uploading this attachment.

    • getDescription

      public String getDescription()
      Returns the description given by the user when uploading this attachment.

    • getRegistrationDetails

      public EntityRegistrationDetails getRegistrationDetails()
      Return the registration details.

    • getDownloadLink

      public String getDownloadLink()
      Returns the download link. In combination with the basic URL (containing host name and port) it can be used to create a URL for downloading the attachment file.

    • compareTo

      public int compareTo(Attachment o)
      Specified by:
      compareTo in interface Comparable<Attachment>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object