Package ch.systemsx.cisd.openbis.generic.shared.api.v1.dto

Class Experiment

java.lang.Object

ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.Experiment

All Implemented Interfaces:

IIdentifierHolder, IIdHolder, java.io.Serializable

@JsonObject("Experiment")
public final class Experiment
extends java.lang.Object
implements java.io.Serializable, IIdentifierHolder, IIdHolder

Immutable value object representing an experiment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Experiment.ExperimentInitializer	Class used to initialize a new experiment instance.

Constructor Summary

Constructors

Constructor	Description
Experiment(Experiment.ExperimentInitializer initializer)	Creates a new instance with the provided initializer

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCode()	Returns the experiment code.
java.lang.String	getExperimentTypeCode()	Returns the experiment type code.
java.lang.Long	getId()	Returns the experiment id.
java.lang.String	getIdentifier()	Returns the experiment identifier.
java.util.List<Metaproject>	getMetaprojects()
java.lang.String	getPermId()	Returns the experiment permanent id.
java.util.Map<java.lang.String,java.lang.String>	getProperties()
EntityRegistrationDetails	getRegistrationDetails()
int	hashCode()
boolean	isStub()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Experiment

public Experiment(Experiment.ExperimentInitializer initializer)

Creates a new instance with the provided initializer

Throws:

java.lang.IllegalArgumentException - if some of the required information is not provided.

Method Detail

getId

public java.lang.Long getId()

Returns the experiment id.

Specified by:

getId in interface IIdHolder

Returns:

null if there is no Id.

getPermId

public java.lang.String getPermId()

Returns the experiment permanent id.

getCode

public java.lang.String getCode()

Returns the experiment code.

getIdentifier

public java.lang.String getIdentifier()

Returns the experiment identifier.

Specified by:

getIdentifier in interface IIdentifierHolder

getExperimentTypeCode

public java.lang.String getExperimentTypeCode()

Returns the experiment type code.

getRegistrationDetails

public EntityRegistrationDetails getRegistrationDetails()

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

getMetaprojects

public java.util.List<Metaproject> getMetaprojects()
                                            throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

isStub

public boolean isStub()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object