Class SharedResultFile

All Implemented Interfaces:
LimsEntityLink<Artifact>, LimsEntityLinkable<Artifact>, LimsLink<Artifact>, Linkable<Artifact>, Locatable, Serializable

public class SharedResultFile extends LimsEntityLinkBase<Artifact>
The file element describes a shared result file output that will be displayed in the step-setup view.
Since:
2.18
See Also:
  • Field Details

    • message

      protected String message
      Error message associated with the shared result file.
    • sharedResultFileIndex

      protected String sharedResultFileIndex
      Index of the shared result file in the configuration.
    • artifactUri

      protected URI artifactUri
      The URI of the artifact representing the shared result file.
    • limsid

      protected String limsid
      The LIMS id of the artifact.
    • name

      protected String name
      The name of the artifact.
  • Constructor Details

    • SharedResultFile

      public SharedResultFile()
      Creates an empty shared result file.
    • SharedResultFile

      public SharedResultFile(URI artifactUri)
      Creates a shared result file with the given artifact URI.
      Parameters:
      artifactUri - The URI of the artifact.
    • SharedResultFile

      public SharedResultFile(URI artifactUri, String limsid)
      Creates a shared result file with the given artifact URI and LIMS id.
      Parameters:
      artifactUri - The URI of the artifact.
      limsid - The LIMS id of the artifact.
    • SharedResultFile

      public SharedResultFile(Linkable<Artifact> link)
      Creates a shared result file from a linkable artifact.
      Parameters:
      link - The linkable artifact to extract the URI from.
      Throws:
      NullPointerException - if link is null.
    • SharedResultFile

      public SharedResultFile(LimsEntityLinkable<Artifact> link)
      Creates a shared result file from a LIMS entity linkable artifact.
      Parameters:
      link - The LIMS entity linkable artifact to extract the URI and LIMS id from.
      Throws:
      NullPointerException - if link is null.
    • SharedResultFile

      public SharedResultFile(Artifact artifact)
      Creates a shared result file from an artifact.
      Parameters:
      artifact - The artifact to extract the URI, LIMS id, and name from.
      Throws:
      NullPointerException - if artifact is null.
  • Method Details

    • getMessage

      public String getMessage()
      Gets the error message.
      Returns:
      The error message, or null if none.
    • setMessage

      public void setMessage(String message)
      Sets the error message.
      Parameters:
      message - The error message.
    • getSharedResultFileIndex

      public String getSharedResultFileIndex()
      Gets the shared result file index.
      Returns:
      The shared result file index.
    • setSharedResultFileIndex

      public void setSharedResultFileIndex(String sharedResultFileIndex)
      Sets the shared result file index.
      Parameters:
      sharedResultFileIndex - The shared result file index.
    • getUri

      public URI getUri()
      Gets the URI of the artifact.
      Returns:
      The artifact URI.
    • setUri

      public void setUri(URI artifactUri)
      Sets the URI of the artifact.
      Parameters:
      artifactUri - The artifact URI.
    • getLimsid

      public String getLimsid()
      Gets the LIMS id of the artifact.
      Returns:
      The LIMS id.
    • setLimsid

      public void setLimsid(String limsid)
      Sets the LIMS id of the artifact.
      Parameters:
      limsid - The LIMS id.
    • getName

      public String getName()
      Gets the name of the artifact.
      Returns:
      The artifact name.
    • setName

      public void setName(String name)
      Sets the name of the artifact.
      Parameters:
      name - The artifact name.
    • getEntityClass

      public Class<Artifact> getEntityClass()
      Get the class of the true, full LIMS entity this object links to.
      Returns:
      The real object class.