Module com.genologics.ri

Package com.genologics.ri.sample

Class SampleCreation

java.lang.Object

com.genologics.ri.sample.SampleBase

com.genologics.ri.sample.SampleCreation

All Implemented Interfaces:

UDFHolder, Serializable

public class SampleCreation
extends SampleBase

Sample creation is the detailed representation required when creating a new Sample in the system.

For this API, this class should not be used directly. Create Sample objects and set their creationLocation field for the initial location before calling ClarityAPI.create methods.

See Also:

• Sample.setCreationLocation(Location)
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Location	location	The location where the sample will be created.

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
SampleCreation()	Constructor for an empty sample creation.
SampleCreation(Sample s)	Construct a new object for sample creation via the API.

Method Summary

Modifier and Type	Method	Description
Location	getLocation()	Gets the location where the sample will be created.
void	setLocation(Location value)	Sets the location where the sample will be created.

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.userdefined.UDFHolder

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

Field Details

location

protected Location location

The location where the sample will be created.

Constructor Details

SampleCreation

public SampleCreation()

Constructor for an empty sample creation.

SampleCreation

public SampleCreation(Sample s)

Construct a new object for sample creation via the API.

Parameters:

s - The original Sample object.

Throws:

IllegalStateException - if s has a URI set (meaning it is already known in the system) or does not have its creationLocation field set with a location.

Method Details

getLocation

public Location getLocation()

Gets the location where the sample will be created.

Returns:

The creation location.

setLocation

public void setLocation(Location value)

Sets the location where the sample will be created.

Parameters:

value - The creation location.