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

Class DataSet

java.lang.Object
ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.DataSet
All Implemented Interfaces:
ICustomIdHolder<Long>, IIdHolder, Serializable
@JsonObject("DataSet") public final class DataSet extends Object implements Serializable, IIdHolder
Immutable value object representing a data set.
See Also:

  • Constructor Details

  • Method Details

    • getId

      public Long getId()
      Returns tech id of the data set.
      Specified by:
      getId in interface ICustomIdHolder<Long>
      Returns:
      null if there is no Id.

    • getCode

      public String getCode()
      Returns the data set code;

    • getExperimentIdentifier

      public String getExperimentIdentifier()
      Returns the identifier of the Experiment to which this data set belongs.
      Returns:
      null if this data set belongs to a sample without experiment. If both getExperimentIdentifier() and getSampleIdentifierOrNull() return null indicate that this data set is not completely filled with all information available. That is, getProperties(), getChildrenCodes(), getParentCodes(), and getContainedDataSets() do not return correct results.

    • getSampleIdentifierOrNull

      public String getSampleIdentifierOrNull()

    • getDataSetTypeCode

      public String getDataSetTypeCode()

    • getRegistrationDate

      public Date getRegistrationDate()

    • getProperties

      public HashMap<String,String> getProperties()

    • getMetaprojects

      public List<Metaproject> getMetaprojects() throws IllegalArgumentException
      Throws:
      IllegalArgumentException

    • getRetrievedConnections

      public EnumSet<DataSet.Connections> getRetrievedConnections()

    • getParentCodes

      public List<String> getParentCodes() throws IllegalArgumentException
      Return the parent codes. This throws an IllegalArgumentException if the parent codes were not retrieved.
      Returns:
      A list of parent data set codes or an empty list if there are no parents.
      Throws:
      IllegalArgumentException - Thrown if the parent codes were not retrieved from the server.

    • getChildrenCodes

      public List<String> getChildrenCodes() throws IllegalArgumentException
      Return the children codes. This throws an IllegalArgumentException if the children codes were not retrieved.
      Returns:
      A list of chidlren data set codes or an empty list if there are no children.
      Throws:
      IllegalArgumentException - Thrown if the children codes were not retrieved from the server.

    • getRegistrationDetails

      public EntityRegistrationDetails getRegistrationDetails()
      Return the data set registration details.
      Since:
      1.11

    • isContainerDataSet

      public boolean isContainerDataSet()

    • getContainerOrNull

      @Deprecated public DataSet getContainerOrNull()
      Deprecated.
      Use getContainerDataSets().
      Since:
      1.20

    • getContainerDataSets

      public List<DataSet> getContainerDataSets()
      Since:
      1.27

    • isLinkDataSet

      public boolean isLinkDataSet()

    • getExternalDataSetCode

      public String getExternalDataSetCode()

    • getExternalDataSetLink

      public String getExternalDataSetLink()

    • getExternalDataManagementSystem

      public ExternalDataManagementSystem getExternalDataManagementSystem()

    • getContainedDataSets

      public List<DataSet> getContainedDataSets()

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getFetchOptions

      public DataSetFetchOptions getFetchOptions()

    • setFetchOptions

      public void setFetchOptions(DataSetFetchOptions fetchOptions)

    • isStorageConfirmed

      public boolean isStorageConfirmed()

    • setStorageConfirmed

      public void setStorageConfirmed(boolean storageConfirmed)

    • isStub

      public boolean isStub()

    • isPostRegistered

      public boolean isPostRegistered()

    • setPostRegistered

      public void setPostRegistered(boolean isInPostRegistrationQueue)