Interface ISampleImmutable
- All Superinterfaces:
IMetaprojectContent
An interface for samples from the database that should not be altered.
-
Method Summary
Modifier and TypeMethodDescriptionbooleanReturn true if this sample object has contained samples available.getCode()Return the code for this sample.Return the contained sample objects.Return the experiment for this sample.Gets the parents of this sampleReturns the permId of this sample.Returns the project for this sample or null.getPropertyValue(String propertyCode) Return the value of a property specified by a code.Return the identifier for this sample.Return the type for this sample.getSpace()Return the space code for this sample.booleanReturn true if the sample exists in the database.Methods inherited from interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IMetaprojectContent
getEntityId
-
Method Details
-
getSampleIdentifier
String getSampleIdentifier()Return the identifier for this sample. -
getSpace
String getSpace()Return the space code for this sample. -
getCode
String getCode()Return the code for this sample. -
getExperiment
IExperimentImmutable getExperiment()Return the experiment for this sample. May be null. -
getProject
IProjectImmutable getProject()Returns the project for this sample or null. -
getSampleType
String getSampleType()Return the type for this sample. May be null. -
isExistingSample
boolean isExistingSample()Return true if the sample exists in the database. -
getPropertyValue
Return the value of a property specified by a code. May return null of no such property with codepropertyCodeis found. -
getContainedSamples
List<ISampleImmutable> getContainedSamples()Return the contained sample objects. Only available for samples existing prior the transaction start that were obtained from the server with their contained samples included. CallcanGetContainedSamples()to see if these can be provided.- Throws:
IllegalStateException- If the contained samples cannot be returned.
-
canGetContainedSamples
boolean canGetContainedSamples()Return true if this sample object has contained samples available. This is independent of whether or not the sample has contained samples. This method only says if the contained samples were provided to this object by the application server. -
getPermId
String getPermId()Returns the permId of this sample. -
getParentSampleIdentifiers
Gets the parents of this sample
-