java.lang.Object
- ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.DataSet

All Implemented Interfaces:

IIdHolder, java.io.Serializable
```
@JsonObject("DataSet")
public final class DataSet
extends java.lang.Object
implements java.io.Serializable, IIdHolder
```
Immutable value object representing a data set.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DataSet.Connections

static class DataSet.DataSetInitializer
Class used to initialize a new data set instance.

Constructor Summary

Constructors
Constructor Description

DataSet(DataSet.DataSetInitializer initializer)
Creates a new instance with the provided initializer

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<java.lang.String>`	`getChildrenCodes()`	Return the children codes.
`java.lang.String`	`getCode()`	Returns the data set code;
`java.util.List<DataSet>`	`getContainedDataSets()`
`java.util.List<DataSet>`	`getContainerDataSets()`
`DataSet`	`getContainerOrNull()`	Deprecated. Use `getContainerDataSets()`.
`java.lang.String`	`getDataSetTypeCode()`
`java.lang.String`	`getExperimentIdentifier()`	Returns the identifier of the Experiment to which this data set belongs.
`ExternalDataManagementSystem`	`getExternalDataManagementSystem()`
`java.lang.String`	`getExternalDataSetCode()`
`java.lang.String`	`getExternalDataSetLink()`
`DataSetFetchOptions`	`getFetchOptions()`
`java.lang.Long`	`getId()`	Returns tech id of the data set.
`java.util.List<Metaproject>`	`getMetaprojects()`
`java.util.List<java.lang.String>`	`getParentCodes()`	Return the parent codes.
`java.util.HashMap<java.lang.String,java.lang.String>`	`getProperties()`
`java.util.Date`	`getRegistrationDate()`
`EntityRegistrationDetails`	`getRegistrationDetails()`	Return the data set registration details.
`java.util.EnumSet<DataSet.Connections>`	`getRetrievedConnections()`
`java.lang.String`	`getSampleIdentifierOrNull()`
`int`	`hashCode()`
`boolean`	`isContainerDataSet()`
`boolean`	`isLinkDataSet()`
`boolean`	`isPostRegistered()`
`boolean`	`isStorageConfirmed()`
`boolean`	`isStub()`
`void`	`setFetchOptions(DataSetFetchOptions fetchOptions)`
`void`	`setPostRegistered(boolean isInPostRegistrationQueue)`
`void`	`setStorageConfirmed(boolean storageConfirmed)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 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 IIdHolder
    
    Returns:
    
    null if there is no Id.
  - getCode
```
public java.lang.String getCode()
```
    Returns the data set code;
  - getExperimentIdentifier
```
public java.lang.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 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<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()
```
  - getContainerOrNull
```
@Deprecated
public DataSet getContainerOrNull()
```
    Deprecated.
    Use getContainerDataSets().
    
    Since:
    
    1.20
  - 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 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
  - 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)
```

Modifier and Type	Class	Description
`static class`	`DataSet.Connections`
`static class`	`DataSet.DataSetInitializer`	Class used to initialize a new data set instance.

Class DataSet

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataSet

Method Detail

getId

getCode

getExperimentIdentifier

getSampleIdentifierOrNull

getDataSetTypeCode

getRegistrationDate

getProperties

getMetaprojects

getRetrievedConnections

getParentCodes

getChildrenCodes

getRegistrationDetails

isContainerDataSet

getContainerOrNull

getContainerDataSets

isLinkDataSet

getExternalDataSetCode

getExternalDataSetLink

getExternalDataManagementSystem

getContainedDataSets

equals

hashCode

toString

getFetchOptions

setFetchOptions

isStorageConfirmed

setStorageConfirmed

isStub

isPostRegistered

setPostRegistered