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:

ICustomIdHolder<Long>, IIdentifierHolder, IIdHolder, Serializable

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

Immutable value object representing an experiment.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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(Object obj)
String	getCode()	Returns the experiment code.
String	getExperimentTypeCode()	Returns the experiment type code.
Long	getId()	Returns the experiment id.
String	getIdentifier()	Returns the experiment identifier.
List<Metaproject>	getMetaprojects()
String	getPermId()	Returns the experiment permanent id.
Map<String,Serializable>	getProperties()
EntityRegistrationDetails	getRegistrationDetails()
int	hashCode()
boolean	isStub()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Experiment

public Experiment(Experiment.ExperimentInitializer initializer)

Creates a new instance with the provided initializer

Throws:

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

Method Details

getId

public Long getId()

Returns the experiment id.

Specified by:

getId in interface ICustomIdHolder<Long>

Returns:

null if there is no Id.

getPermId

public String getPermId()

Returns the experiment permanent id.

getCode

public String getCode()

Returns the experiment code.

getIdentifier

public String getIdentifier()

Returns the experiment identifier.

Specified by:

getIdentifier in interface IIdentifierHolder

getExperimentTypeCode

public String getExperimentTypeCode()

Returns the experiment type code.

getRegistrationDetails

public EntityRegistrationDetails getRegistrationDetails()

getProperties

public Map<String,Serializable> getProperties()

getMetaprojects

public List<Metaproject> getMetaprojects()
                                  throws IllegalArgumentException

Throws:

IllegalArgumentException

isStub

public boolean isStub()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object