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

Class DataSet

  • All Implemented Interfaces:
    ch.systemsx.cisd.openbis.generic.shared.basic.IIdHolder, java.io.Serializable
    @JsonObject("DataSet")
public final class DataSet
extends java.lang.Object
implements java.io.Serializable, ch.systemsx.cisd.openbis.generic.shared.basic.IIdHolder
    Immutable value object representing a data set.
    See Also:
    Serialized Form

    • Constructor Detail

      • DataSet

        public DataSet​(DataSet.DataSetInitializer initializer)
        Creates a new instance with the provided initializer
        Throws:
        java.lang.IllegalArgumentException - if some of the required information is not provided.

    • Method Detail

      • getId

        public java.lang.Long getId()
        Returns tech id of the data set.
        Specified by:
        getId in interface ch.systemsx.cisd.openbis.generic.shared.basic.IIdHolder

      • getCode

        public java.lang.String getCode()
        Returns the data set code;

      • getSampleIdentifierOrNull

        public java.lang.String getSampleIdentifierOrNull()

      • getDataSetTypeCode

        public java.lang.String getDataSetTypeCode()

      • getRegistrationDate

        public java.util.Date getRegistrationDate()

      • getProperties

        public java.util.HashMap<java.lang.String,​java.lang.String> getProperties()

      • getMetaprojects

        public java.util.List<ch.systemsx.cisd.openbis.generic.shared.basic.dto.Metaproject> getMetaprojects()
                                                                                              throws java.lang.IllegalArgumentException
        Throws:
        java.lang.IllegalArgumentException

      • getRetrievedConnections

        public java.util.EnumSet<DataSet.Connections> getRetrievedConnections()

      • getParentCodes

        public java.util.List<java.lang.String> getParentCodes()
                                                throws java.lang.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:
        java.lang.IllegalArgumentException - Thrown if the parent codes were not retrieved from the server.

      • getChildrenCodes

        public java.util.List<java.lang.String> getChildrenCodes()
                                                  throws java.lang.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:
        java.lang.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()

      • getContainerDataSets

        public java.util.List<DataSet> getContainerDataSets()
        Since:
        1.27

      • isLinkDataSet

        public boolean isLinkDataSet()

      • getExternalDataSetCode

        public java.lang.String getExternalDataSetCode()

      • getExternalDataSetLink

        public java.lang.String getExternalDataSetLink()

      • getExternalDataManagementSystem

        public ch.systemsx.cisd.openbis.generic.shared.basic.dto.ExternalDataManagementSystem getExternalDataManagementSystem()

      • getContainedDataSets

        public java.util.List<DataSet> getContainedDataSets()

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • isStorageConfirmed

        public boolean isStorageConfirmed()

      • setStorageConfirmed

        public void setStorageConfirmed​(boolean storageConfirmed)

      • isStub

        public boolean isStub()

      • isPostRegistered

        public boolean isPostRegistered()

      • setPostRegistered

        public void setPostRegistered​(boolean isInPostRegistrationQueue)