Package ch.ethz.sis.openbis.generic.asapi.v3.dto.sample

Class Sample

java.lang.Object

ch.ethz.sis.openbis.generic.asapi.v3.dto.common.entity.AbstractEntityPropertyHolder

ch.ethz.sis.openbis.generic.asapi.v3.dto.common.entity.AbstractEntity<Sample>

ch.ethz.sis.openbis.generic.asapi.v3.dto.sample.Sample

All Implemented Interfaces:

IAttachmentsHolder, ICodeHolder, IDataSetsHolder, IEntityTypeHolder, IExperimentHolder, IIdentifierHolder, IModificationDateHolder, IModifierHolder, IParentChildrenHolder<Sample>, IPermIdHolder, IProjectHolder, IPropertiesHolder, IRegistrationDateHolder, IRegistratorHolder, ISpaceHolder, ITagsHolder, Serializable

@JsonObject("as.dto.sample.Sample")
public class Sample
extends AbstractEntity<Sample>
implements Serializable, IAttachmentsHolder, ICodeHolder, IDataSetsHolder, IEntityTypeHolder, IExperimentHolder, IIdentifierHolder, IModificationDateHolder, IModifierHolder, IParentChildrenHolder<Sample>, IPermIdHolder, IProjectHolder, IPropertiesHolder, IRegistrationDateHolder, IRegistratorHolder, ISpaceHolder, ITagsHolder

See Also:

• Serialized Form

Field Summary

Fields inherited from class ch.ethz.sis.openbis.generic.asapi.v3.dto.common.entity.AbstractEntityPropertyHolder

properties

Constructor Summary

Constructors

Constructor	Description
Sample()

Method Summary

Modifier and Type	Method	Description
List<Attachment>	getAttachments()
Relationship	getChildRelationship(ISampleId childId)
List<Sample>	getChildren()
List<HistoryEntry>	getChildrenHistory()
Map<SamplePermId,Relationship>	getChildrenRelationships()
String	getCode()
List<Sample>	getComponents()
List<HistoryEntry>	getComponentsHistory()
Sample	getContainer()
List<HistoryEntry>	getContainerHistory()
List<DataSet>	getDataSets()
List<HistoryEntry>	getDataSetsHistory()
Experiment	getExperiment()
List<HistoryEntry>	getExperimentHistory()
SampleFetchOptions	getFetchOptions()
List<HistoryEntry>	getHistory()
SampleIdentifier	getIdentifier()
Date	getImmutableDataDate()
Map<String,String>	getMetaData()
Date	getModificationDate()
Person	getModifier()
Relationship	getParentRelationship(ISampleId parentId)
List<Sample>	getParents()
List<HistoryEntry>	getParentsHistory()
Map<SamplePermId,Relationship>	getParentsRelationships()
SamplePermId	getPermId()
Project	getProject()
List<HistoryEntry>	getProjectHistory()
List<HistoryEntry>	getPropertiesHistory()
Date	getRegistrationDate()
Person	getRegistrator()
Map<String,Sample[]>	getSampleProperties()
Space	getSpace()
List<HistoryEntry>	getSpaceHistory()
Set<Tag>	getTags()
SampleType	getType()
List<HistoryEntry>	getUnknownHistory()
boolean	isFrozen()
boolean	isFrozenForChildren()
boolean	isFrozenForComponents()
boolean	isFrozenForDataSets()
boolean	isFrozenForParents()
boolean	isImmutableData()
void	setAttachments(List<Attachment> attachments)
void	setChildren(List<Sample> children)
void	setChildrenHistory(List<HistoryEntry> childrenHistory)
void	setChildrenRelationships(Map<SamplePermId,Relationship> childrenRelationships)
void	setCode(String code)
void	setComponents(List<Sample> components)
void	setComponentsHistory(List<HistoryEntry> componentsHistory)
void	setContainer(Sample container)
void	setContainerHistory(List<HistoryEntry> containerHistory)
void	setDataSets(List<DataSet> dataSets)
void	setDataSetsHistory(List<HistoryEntry> dataSetsHistory)
void	setExperiment(Experiment experiment)
void	setExperimentHistory(List<HistoryEntry> experimentHistory)
void	setFetchOptions(SampleFetchOptions fetchOptions)
void	setFrozen(boolean frozen)
void	setFrozenForChildren(boolean frozenForChildren)
void	setFrozenForComponents(boolean frozenForComponents)
void	setFrozenForDataSets(boolean frozenForDataSets)
void	setFrozenForParents(boolean frozenForParents)
void	setHistory(List<HistoryEntry> history)
void	setIdentifier(SampleIdentifier identifier)
void	setImmutableDataDate(Date immutableDataDate)
void	setMetaData(Map<String,String> metaData)
void	setModificationDate(Date modificationDate)
void	setModifier(Person modifier)
void	setParents(List<Sample> parents)
void	setParentsHistory(List<HistoryEntry> parentsHistory)
void	setParentsRelationships(Map<SamplePermId,Relationship> parentsRelationships)
void	setPermId(SamplePermId permId)
void	setProject(Project project)
void	setProjectHistory(List<HistoryEntry> projectHistory)
void	setPropertiesHistory(List<HistoryEntry> propertiesHistory)
void	setRegistrationDate(Date registrationDate)
void	setRegistrator(Person registrator)
void	setSampleProperties(Map<String,Sample[]> sampleProperties)
void	setSpace(Space space)
void	setSpaceHistory(List<HistoryEntry> spaceHistory)
void	setTags(Set<Tag> tags)
void	setType(SampleType type)
void	setUnknownHistory(List<HistoryEntry> unknownHistory)
String	toString()

Methods inherited from class ch.ethz.sis.openbis.generic.asapi.v3.dto.common.entity.AbstractEntity

getProperties, setFetchOptions, setProperties

Methods inherited from class ch.ethz.sis.openbis.generic.asapi.v3.dto.common.entity.AbstractEntityPropertyHolder

getBooleanProperty, getControlledVocabularyProperty, getHyperlinkProperty, getIntegerArrayProperty, getIntegerProperty, getJsonProperty, getMultiValueBooleanProperty, getMultiValueControlledVocabularyProperty, getMultiValueHyperlinkProperty, getMultiValueIntegerArrayProperty, getMultiValueIntegerProperty, getMultiValueJsonProperty, getMultiValueRealArrayProperty, getMultiValueRealProperty, getMultiValueSampleProperty, getMultiValueStringArrayProperty, getMultiValueStringProperty, getMultiValueTimestampArrayProperty, getMultiValueTimestampProperty, getMultiValueXmlProperty, getProperty, getRealArrayProperty, getRealProperty, getRichTextProperty, getSampleProperty, getSpreadsheetProperty, getStringArrayProperty, getStringProperty, getTimestampArrayProperty, getTimestampProperty, getXmlProperty, setBooleanProperty, setControlledVocabularyProperty, setHyperlinkProperty, setIntegerArrayProperty, setIntegerProperty, setJsonProperty, setMultiValueBooleanProperty, setMultiValueControlledVocabularyProperty, setMultiValueHyperlinkProperty, setMultiValueIntegerArrayProperty, setMultiValueIntegerProperty, setMultiValueJsonProperty, setMultiValueRealArrayProperty, setMultiValueRealProperty, setMultiValueSampleProperty, setMultiValueStringArrayProperty, setMultiValueStringProperty, setMultiValueTimestampArrayProperty, setMultiValueTimestampProperty, setMultiValueXmlProperty, setProperty, setRealArrayProperty, setRealProperty, setRichTextProperty, setSampleProperty, setSpreadsheetProperty, setStringArrayProperty, setStringProperty, setTimestampArrayProperty, setTimestampProperty, setXmlProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.ethz.sis.openbis.generic.asapi.v3.dto.common.interfaces.IPropertiesHolder

getBooleanProperty, getControlledVocabularyProperty, getHyperlinkProperty, getIntegerArrayProperty, getIntegerProperty, getJsonProperty, getMultiValueBooleanProperty, getMultiValueControlledVocabularyProperty, getMultiValueHyperlinkProperty, getMultiValueIntegerArrayProperty, getMultiValueIntegerProperty, getMultiValueJsonProperty, getMultiValueRealArrayProperty, getMultiValueRealProperty, getMultiValueSampleProperty, getMultiValueStringArrayProperty, getMultiValueStringProperty, getMultiValueTimestampArrayProperty, getMultiValueTimestampProperty, getMultiValueXmlProperty, getProperties, getProperty, getRealArrayProperty, getRealProperty, getRichTextProperty, getSampleProperty, getSpreadsheetProperty, getStringArrayProperty, getStringProperty, getTimestampArrayProperty, getTimestampProperty, getXmlProperty, setBooleanProperty, setControlledVocabularyProperty, setHyperlinkProperty, setIntegerArrayProperty, setIntegerProperty, setJsonProperty, setMultiValueBooleanProperty, setMultiValueControlledVocabularyProperty, setMultiValueHyperlinkProperty, setMultiValueIntegerArrayProperty, setMultiValueIntegerProperty, setMultiValueJsonProperty, setMultiValueRealArrayProperty, setMultiValueRealProperty, setMultiValueSampleProperty, setMultiValueStringArrayProperty, setMultiValueStringProperty, setMultiValueTimestampArrayProperty, setMultiValueTimestampProperty, setMultiValueXmlProperty, setProperties, setProperty, setRealArrayProperty, setRealProperty, setRichTextProperty, setSampleProperty, setSpreadsheetProperty, setStringArrayProperty, setStringProperty, setTimestampArrayProperty, setTimestampProperty, setXmlProperty

Constructor Details

Sample

public Sample()

Method Details

getFetchOptions

public SampleFetchOptions getFetchOptions()

Overrides:

getFetchOptions in class AbstractEntity<Sample>

setFetchOptions

public void setFetchOptions(SampleFetchOptions fetchOptions)

getPermId

public SamplePermId getPermId()

Specified by:

getPermId in interface IPermIdHolder

setPermId

public void setPermId(SamplePermId permId)

getIdentifier

public SampleIdentifier getIdentifier()

Specified by:

getIdentifier in interface IIdentifierHolder

setIdentifier

public void setIdentifier(SampleIdentifier identifier)

getCode

public String getCode()

Specified by:

getCode in interface ICodeHolder

setCode

public void setCode(String code)

isFrozen

public boolean isFrozen()

setFrozen

public void setFrozen(boolean frozen)

isFrozenForComponents

public boolean isFrozenForComponents()

setFrozenForComponents

public void setFrozenForComponents(boolean frozenForComponents)

isFrozenForChildren

public boolean isFrozenForChildren()

setFrozenForChildren

public void setFrozenForChildren(boolean frozenForChildren)

isFrozenForParents

public boolean isFrozenForParents()

setFrozenForParents

public void setFrozenForParents(boolean frozenForParents)

isFrozenForDataSets

public boolean isFrozenForDataSets()

setFrozenForDataSets

public void setFrozenForDataSets(boolean frozenForDataSets)

getRegistrationDate

public Date getRegistrationDate()

Specified by:

getRegistrationDate in interface IRegistrationDateHolder

setRegistrationDate

public void setRegistrationDate(Date registrationDate)

getModificationDate

public Date getModificationDate()

Specified by:

getModificationDate in interface IModificationDateHolder

setModificationDate

public void setModificationDate(Date modificationDate)

getType

public SampleType getType()

Specified by:

getType in interface IEntityTypeHolder

setType

public void setType(SampleType type)

getProject

public Project getProject()

Specified by:

getProject in interface IProjectHolder

setProject

public void setProject(Project project)

getSpace

public Space getSpace()

Specified by:

getSpace in interface ISpaceHolder

setSpace

public void setSpace(Space space)

getExperiment

public Experiment getExperiment()

Specified by:

getExperiment in interface IExperimentHolder

setExperiment

public void setExperiment(Experiment experiment)

getSampleProperties

public Map<String,Sample[]> getSampleProperties()

setSampleProperties

public void setSampleProperties(Map<String,Sample[]> sampleProperties)

getParents

public List<Sample> getParents()

Specified by:

getParents in interface IParentChildrenHolder<Sample>

setParents

public void setParents(List<Sample> parents)

getParentsRelationships

public Map<SamplePermId,Relationship> getParentsRelationships()

setParentsRelationships

public void setParentsRelationships(Map<SamplePermId,Relationship> parentsRelationships)

getChildren

public List<Sample> getChildren()

Specified by:

getChildren in interface IParentChildrenHolder<Sample>

setChildren

public void setChildren(List<Sample> children)

getChildrenRelationships

public Map<SamplePermId,Relationship> getChildrenRelationships()

setChildrenRelationships

public void setChildrenRelationships(Map<SamplePermId,Relationship> childrenRelationships)

getContainer

public Sample getContainer()

setContainer

public void setContainer(Sample container)

getComponents

public List<Sample> getComponents()

setComponents

public void setComponents(List<Sample> components)

getDataSets

public List<DataSet> getDataSets()

Specified by:

getDataSets in interface IDataSetsHolder

setDataSets

public void setDataSets(List<DataSet> dataSets)

getHistory

public List<HistoryEntry> getHistory()

setHistory

public void setHistory(List<HistoryEntry> history)

getPropertiesHistory

public List<HistoryEntry> getPropertiesHistory()

setPropertiesHistory

public void setPropertiesHistory(List<HistoryEntry> propertiesHistory)

getSpaceHistory

public List<HistoryEntry> getSpaceHistory()

setSpaceHistory

public void setSpaceHistory(List<HistoryEntry> spaceHistory)

getProjectHistory

public List<HistoryEntry> getProjectHistory()

setProjectHistory

public void setProjectHistory(List<HistoryEntry> projectHistory)

getExperimentHistory

public List<HistoryEntry> getExperimentHistory()

setExperimentHistory

public void setExperimentHistory(List<HistoryEntry> experimentHistory)

getParentsHistory

public List<HistoryEntry> getParentsHistory()

setParentsHistory

public void setParentsHistory(List<HistoryEntry> parentsHistory)

getChildrenHistory

public List<HistoryEntry> getChildrenHistory()

setChildrenHistory

public void setChildrenHistory(List<HistoryEntry> childrenHistory)

getContainerHistory

public List<HistoryEntry> getContainerHistory()

setContainerHistory

public void setContainerHistory(List<HistoryEntry> containerHistory)

getComponentsHistory

public List<HistoryEntry> getComponentsHistory()

setComponentsHistory

public void setComponentsHistory(List<HistoryEntry> componentsHistory)

getDataSetsHistory

public List<HistoryEntry> getDataSetsHistory()

setDataSetsHistory

public void setDataSetsHistory(List<HistoryEntry> dataSetsHistory)

getUnknownHistory

public List<HistoryEntry> getUnknownHistory()

setUnknownHistory

public void setUnknownHistory(List<HistoryEntry> unknownHistory)

getTags

public Set<Tag> getTags()

Specified by:

getTags in interface ITagsHolder

setTags

public void setTags(Set<Tag> tags)

getRegistrator

public Person getRegistrator()

Specified by:

getRegistrator in interface IRegistratorHolder

setRegistrator

public void setRegistrator(Person registrator)

getModifier

public Person getModifier()

Specified by:

getModifier in interface IModifierHolder

setModifier

public void setModifier(Person modifier)

getAttachments

public List<Attachment> getAttachments()

Specified by:

getAttachments in interface IAttachmentsHolder

setAttachments

public void setAttachments(List<Attachment> attachments)

getParentRelationship

public Relationship getParentRelationship(ISampleId parentId)

getChildRelationship

public Relationship getChildRelationship(ISampleId childId)

getMetaData

public Map<String,String> getMetaData()

setMetaData

public void setMetaData(Map<String,String> metaData)

isImmutableData

public boolean isImmutableData()

getImmutableDataDate

public Date getImmutableDataDate()

setImmutableDataDate

public void setImmutableDataDate(Date immutableDataDate)

toString

public String toString()

Overrides:

toString in class Object