@JsonObject(value="Sample")
public final class Sample
extends java.lang.Object
implements java.io.Serializable, ch.systemsx.cisd.openbis.generic.shared.basic.IIdentifierHolder, ch.systemsx.cisd.openbis.generic.shared.basic.IIdHolder
Modifier and Type | Class and Description |
---|---|
static class |
Sample.SampleInitializer
Class used to initialize a new sample instance.
|
Constructor and Description |
---|
Sample(Sample.SampleInitializer initializer)
Creates a new instance with the provided initializer
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.util.List<Sample> |
getChildren()
Return the children.
|
java.util.List<Sample> |
getChildrenJson() |
java.lang.String |
getCode()
Returns the sample code.
|
java.lang.String |
getExperimentIdentifierOrNull() |
java.lang.Long |
getId()
Returns the sample id.
|
java.lang.String |
getIdentifier()
Returns the sample identifier;
|
java.util.List<ch.systemsx.cisd.openbis.generic.shared.basic.dto.Metaproject> |
getMetaprojects() |
java.util.List<ch.systemsx.cisd.openbis.generic.shared.basic.dto.Metaproject> |
getMetaprojectsJson() |
java.util.List<Sample> |
getParents()
Return the parents.
|
java.util.List<Sample> |
getParentsJson() |
java.lang.String |
getPermId()
Returns the sample permanent id.
|
java.util.Map<java.lang.String,java.lang.String> |
getProperties() |
java.util.Map<java.lang.String,java.lang.String> |
getPropertiesJson() |
EntityRegistrationDetails |
getRegistrationDetails()
Return the sample registration details.
|
java.util.EnumSet<SampleFetchOption> |
getRetrievedFetchOptions()
Returns fetch options used to retrieved this sample object.
|
java.lang.String |
getSampleTypeCode()
Returns the sample type code.
|
java.lang.Long |
getSampleTypeId()
Returns the sample type id.
|
java.lang.String |
getSpaceCode()
Returns the space code.
|
int |
hashCode() |
boolean |
isStub() |
java.lang.String |
toString() |
public Sample(Sample.SampleInitializer initializer)
java.lang.IllegalArgumentException
- if some of the required information is not provided.public java.lang.Long getId()
getId
in interface ch.systemsx.cisd.openbis.generic.shared.basic.IIdHolder
null
if there is no Id.public java.lang.String getSpaceCode()
public java.lang.String getPermId()
public java.lang.String getCode()
public java.lang.String getIdentifier()
getIdentifier
in interface ch.systemsx.cisd.openbis.generic.shared.basic.IIdentifierHolder
public java.lang.String getExperimentIdentifierOrNull()
public java.lang.Long getSampleTypeId()
public java.lang.String getSampleTypeCode()
public java.util.Map<java.lang.String,java.lang.String> getProperties() throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public java.util.List<ch.systemsx.cisd.openbis.generic.shared.basic.dto.Metaproject> getMetaprojects() throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public EntityRegistrationDetails getRegistrationDetails()
public java.util.EnumSet<SampleFetchOption> getRetrievedFetchOptions()
public java.util.List<Sample> getChildren() throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
- Thrown if the children were not retrieved from the server.public java.util.List<Sample> getParents() throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
- Thrown if the parents were not retrieved from the server.public boolean isStub()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.Map<java.lang.String,java.lang.String> getPropertiesJson()
public java.util.List<ch.systemsx.cisd.openbis.generic.shared.basic.dto.Metaproject> getMetaprojectsJson()
public java.util.List<Sample> getChildrenJson()
public java.util.List<Sample> getParentsJson()