Module com.genologics.ri

Package com.genologics.ri.sample

Class Sample

java.lang.Object

com.genologics.ri.sample.SampleBase

com.genologics.ri.sample.Sample

All Implemented Interfaces:

LimsEntity<Sample>, LimsEntityLinkable<Sample>, Linkable<Sample>, Locatable, UDFHolder, Serializable

public class Sample
extends SampleBase
implements LimsEntity<Sample>

The detailed representation of a sample.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.genologics.ri.sample.SampleBase

artifact, bioSource, controlType, dateCompleted, dateReceived, externalIds, fields, files, limsid, name, project, submitter, type, uri

Constructor Summary

Constructors

Constructor	Description
Sample()

Method Summary

Modifier and Type	Method	Description
Location	getCreationLocation()	Get the initial creation location for this sample.
LimsEntityLink<Sample>	getLink()	Get a concrete link object to this LimsEntityLinkable entity.
void	setCreationLocation(LimsEntityLinkable<Container> container, String position)	Set the location of this sample for creation.
void	setCreationLocation(Location creationLocation)	Set the location of this sample for creation.

Methods inherited from class com.genologics.ri.sample.SampleBase

addFile, getArtifact, getBioSource, getControlType, getDateCompleted, getDateReceived, getExternalIds, getFiles, getLimsid, getName, getProject, getSubmitter, getUri, getUserDefinedFields, getUserDefinedType, isControlSample, setArtifact, setBioSource, setControlType, setDateCompleted, setDateReceived, setLimsid, setName, setProject, setSubmitter, setUri, setUserDefinedType, setUserDefinedType, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.genologics.ri.LimsEntityLinkable

getLimsid, getLimsId, setLimsid, setLimsId

Methods inherited from interface com.genologics.ri.Locatable

getUri, setUri

Methods inherited from interface com.genologics.ri.userdefined.UDFHolder

getUDF, getUDF, getUDF, getUdfs, getUDFs, getUDFValue, getUDFValue, getUDFValue, getUDFValue, setUDF

Constructor Details

Sample

public Sample()

Method Details

getCreationLocation

public Location getCreationLocation()

Get the initial creation location for this sample.

Returns:

The initial location.

setCreationLocation

public void setCreationLocation(Location creationLocation)

Set the location of this sample for creation. This is required when creating samples via the API only.

Parameters:

creationLocation - The initial location of the sample.

setCreationLocation

public void setCreationLocation(LimsEntityLinkable<Container> container,
 String position)

Set the location of this sample for creation. This is required when creating samples via the API only.

Parameters:

container - The container the sample will be created in.

position - The position within the container for the sample.

getLink

public LimsEntityLink<Sample> getLink()

Get a concrete link object to this LimsEntityLinkable entity. This definition simply narrows the type of links returned by classes that implement this interface, as they should all have corresponding LimsEntityLink link classes available.

Specified by:

getLink in interface LimsEntityLinkable<Sample>

Specified by:

getLink in interface Linkable<Sample>

Returns:

A LimsEntityLink to this object.