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

Class SampleType

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

@JsonObject("SampleType")
public class SampleType
extends EntityType

Immutable value object representing a sample type.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SampleType.SampleTypeInitializer	Class used to initialize a new SampleType instance.

Constructor Summary

Constructors

Constructor	Description
SampleType(SampleType.SampleTypeInitializer initializer)	Creates a new instance with the provided initializer

Method Summary

Modifier and Type	Method	Description
String	getCodePrefix()	Returns code prefix used to create sample code automatically.
boolean	isAutomaticCodeGeneration()	Returns true if the sample code is created automatically.
boolean	isListable()	Returns true if this is a sample type of listable samples.
boolean	isShowContainer()	Returns true if for samples of this type the container field is shown in edit/registration form.
boolean	isShowParentMetaData()	Returns true if meta data of parents of samples of this type should be shown.
boolean	isShowParents()	Returns true if for sample of this type the parents field is shown in edit/registration form.
boolean	isUniqueSubcodes()	Returns true if the sub code of samples of this type has to be unique.
String	toString()

Methods inherited from class ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.EntityType

equals, getCode, getDescription, getPropertyTypeGroups, getValidationPluginInfo, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

SampleType

public SampleType(SampleType.SampleTypeInitializer initializer)

Creates a new instance with the provided initializer

Throws:

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

Method Details

isListable

public boolean isListable()

Returns true if this is a sample type of listable samples.

isShowContainer

public boolean isShowContainer()

Returns true if for samples of this type the container field is shown in edit/registration form.

isShowParents

public boolean isShowParents()

Returns true if for sample of this type the parents field is shown in edit/registration form.

isUniqueSubcodes

public boolean isUniqueSubcodes()

Returns true if the sub code of samples of this type has to be unique.

isAutomaticCodeGeneration

public boolean isAutomaticCodeGeneration()

Returns true if the sample code is created automatically.

isShowParentMetaData

public boolean isShowParentMetaData()

Returns true if meta data of parents of samples of this type should be shown.

getCodePrefix

public String getCodePrefix()

Returns code prefix used to create sample code automatically.

toString

public String toString()

Overrides:

toString in class Object