Module org.cruk.clarity.api

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)
• ClarityAPI.create(com.genologics.ri.Locatable)
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Location	location

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

Method Summary

Modifier and Type	Method	Description
Location	getLocation()
void	setLocation(Location value)

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

addFile, addUserDefinedField, addUserDefinedField, getArtifact, getBioSource, getControlType, getDateCompleted, getDateReceived, getExternalIds, getFiles, getLimsid, getName, getProject, getSubmitter, getUri, getUserDefinedField, 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

Constructor Details

SampleCreation

public SampleCreation()

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()

setLocation

public void setLocation(Location value)