Class SampleImmutable
- java.lang.Object
-
- ch.systemsx.cisd.etlserver.registrator.api.v2.impl.SampleImmutable
-
- All Implemented Interfaces:
ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IMetaprojectContent,ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
- Direct Known Subclasses:
Sample
public class SampleImmutable extends java.lang.Object implements ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
-
-
Constructor Summary
Constructors Constructor Description SampleImmutable(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample)Creates a new object that wraps the sample, which is assumed be an existing sample with all fetch options retrieved.SampleImmutable(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample, boolean existingSample)Creates a new object that wraps the sample, which is assumed to have all fetch options retrieved.SampleImmutable(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample, java.util.EnumSet<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SampleFetchOption> retrievedFetchOptions)Creates a new object that wraps the sample, which is assumed be an existing sample.SampleImmutable(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample, java.util.EnumSet<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SampleFetchOption> retrievedFetchOptions, boolean existingSample)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancanGetContainedSamples()protected voidcheckExists()Throw an exception if the sample does not existbooleanequals(java.lang.Object obj)java.lang.StringgetCode()java.util.List<ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable>getContainedSamples()ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.id.IObjectIdgetEntityId()ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExperimentImmutablegetExperiment()java.lang.LonggetId()java.util.List<java.lang.String>getParentSampleIdentifiers()java.lang.StringgetPermId()ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IProjectImmutablegetProject()java.lang.StringgetPropertyValue(java.lang.String propertyCode)ch.systemsx.cisd.openbis.generic.shared.basic.dto.SamplegetSample()java.lang.StringgetSampleIdentifier()java.lang.StringgetSampleType()java.lang.StringgetSpace()inthashCode()booleanisExistingSample()
-
-
-
Constructor Detail
-
SampleImmutable
public SampleImmutable(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample)
Creates a new object that wraps the sample, which is assumed be an existing sample with all fetch options retrieved.- Parameters:
sample- The sample to wrap.
-
SampleImmutable
public SampleImmutable(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample, java.util.EnumSet<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SampleFetchOption> retrievedFetchOptions)Creates a new object that wraps the sample, which is assumed be an existing sample.- Parameters:
sample- The sample to wrap.retrievedFetchOptions- The fetch options the sample includes.
-
SampleImmutable
public SampleImmutable(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample, boolean existingSample)Creates a new object that wraps the sample, which is assumed to have all fetch options retrieved.- Parameters:
sample- The sample to wrap.existingSample- True if the sample exists in the DB.
-
SampleImmutable
public SampleImmutable(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample sample, java.util.EnumSet<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SampleFetchOption> retrievedFetchOptions, boolean existingSample)
-
-
Method Detail
-
getExperiment
public ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExperimentImmutable getExperiment()
- Specified by:
getExperimentin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
-
getProject
public ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IProjectImmutable getProject()
- Specified by:
getProjectin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
-
getSampleIdentifier
public java.lang.String getSampleIdentifier()
- Specified by:
getSampleIdentifierin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
-
getId
public java.lang.Long getId()
-
getEntityId
public ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.id.IObjectId getEntityId()
- Specified by:
getEntityIdin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IMetaprojectContent
-
getSample
public ch.systemsx.cisd.openbis.generic.shared.basic.dto.Sample getSample()
-
isExistingSample
public boolean isExistingSample()
- Specified by:
isExistingSamplein interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
-
checkExists
protected void checkExists()
Throw an exception if the sample does not exist
-
getPropertyValue
public java.lang.String getPropertyValue(java.lang.String propertyCode)
- Specified by:
getPropertyValuein interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
-
getSampleType
public java.lang.String getSampleType()
- Specified by:
getSampleTypein interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
-
getSpace
public java.lang.String getSpace()
- Specified by:
getSpacein interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
-
getCode
public java.lang.String getCode()
- Specified by:
getCodein interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
-
getPermId
public java.lang.String getPermId()
- Specified by:
getPermIdin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
-
getContainedSamples
public java.util.List<ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable> getContainedSamples()
- Specified by:
getContainedSamplesin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
-
getParentSampleIdentifiers
public java.util.List<java.lang.String> getParentSampleIdentifiers()
- Specified by:
getParentSampleIdentifiersin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
-
canGetContainedSamples
public boolean canGetContainedSamples()
- Specified by:
canGetContainedSamplesin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
-