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

Class Sample

java.lang.Object

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

All Implemented Interfaces:

ICustomIdHolder<Long>, IIdentifierHolder, IIdHolder, Serializable

@JsonObject("Sample")
public final class Sample
extends Object
implements Serializable, IIdentifierHolder, IIdHolder

Immutable value object representing a sample.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Sample.SampleInitializer	Class used to initialize a new sample instance.

Constructor Summary

Constructors

Constructor	Description
Sample(Sample.SampleInitializer initializer)	Creates a new instance with the provided initializer

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<Sample>	getChildren()	Return the children.
List<Sample>	getChildrenJson()
String	getCode()	Returns the sample code.
String	getExperimentIdentifierOrNull()
Long	getId()	Returns the sample id.
String	getIdentifier()	Returns the sample identifier;
List<Metaproject>	getMetaprojects()
List<Metaproject>	getMetaprojectsJson()
List<Sample>	getParents()	Return the parents.
List<Sample>	getParentsJson()
String	getPermId()	Returns the sample permanent id.
Map<String,String>	getProperties()
Map<String,String>	getPropertiesJson()
EntityRegistrationDetails	getRegistrationDetails()	Return the sample registration details.
EnumSet<SampleFetchOption>	getRetrievedFetchOptions()	Returns fetch options used to retrieved this sample object.
String	getSampleTypeCode()	Returns the sample type code.
Long	getSampleTypeId()	Returns the sample type id.
String	getSpaceCode()	Returns the space code.
int	hashCode()
boolean	isStub()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Sample

public Sample(Sample.SampleInitializer initializer)

Creates a new instance with the provided initializer

Throws:

IllegalArgumentException - if some of the required information is not provided.

Method Details

getId

public Long getId()

Returns the sample id.

Specified by:

getId in interface ICustomIdHolder<Long>

Returns:

null if there is no Id.

getSpaceCode

public String getSpaceCode()

Returns the space code.

getPermId

public String getPermId()

Returns the sample permanent id.

getCode

public String getCode()

Returns the sample code.

getIdentifier

public String getIdentifier()

Returns the sample identifier;

Specified by:

getIdentifier in interface IIdentifierHolder

getExperimentIdentifierOrNull

public String getExperimentIdentifierOrNull()

getSampleTypeId

public Long getSampleTypeId()

Returns the sample type id.

getSampleTypeCode

public String getSampleTypeCode()

Returns the sample type code.

getProperties

public Map<String,String> getProperties()
                                 throws IllegalArgumentException

Throws:

IllegalArgumentException

getMetaprojects

public List<Metaproject> getMetaprojects()
                                  throws IllegalArgumentException

Throws:

IllegalArgumentException

getRegistrationDetails

public EntityRegistrationDetails getRegistrationDetails()

Return the sample registration details.

Since:

1.11

getRetrievedFetchOptions

public EnumSet<SampleFetchOption> getRetrievedFetchOptions()

Returns fetch options used to retrieved this sample object.

getChildren

public List<Sample> getChildren()
                         throws IllegalArgumentException

Return the children.

Returns:

Children of this sample or an empty list if there are no children.

Throws:

IllegalArgumentException - Thrown if the children were not retrieved from the server.

getParents

public List<Sample> getParents()
                        throws IllegalArgumentException

Return the parents.

Returns:

All parents of this sample or an empty list if there are no parents.

Throws:

IllegalArgumentException - Thrown if the parents were not retrieved from the server.

isStub

public boolean isStub()

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

getPropertiesJson

public Map<String,String> getPropertiesJson()

getMetaprojectsJson

public List<Metaproject> getMetaprojectsJson()

getChildrenJson

public List<Sample> getChildrenJson()

getParentsJson

public List<Sample> getParentsJson()