Package ch.systemsx.cisd.openbis.generic.shared.basic.dto

Class ListSampleCriteria

java.lang.Object

ch.systemsx.cisd.openbis.generic.shared.basic.dto.ListSampleCriteria

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ListOrSearchSampleCriteria

public class ListSampleCriteria
extends java.lang.Object
implements java.io.Serializable

Criteria for listing samples. This class offers 3 kinds of filters, but only one can be used at the same time:

1. samples of particular type in a specified space and/or shared
2. samples belonging to a container sample
3. samples derived from a parent sample
4. samples connected with a child sample
5. samples from the experiment

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ListSampleCriteria()

Method Summary

Modifier and Type	Method	Description
static ListSampleCriteria	createForChild(TechId childSampleId)
static ListSampleCriteria	createForChildren(java.util.Collection<java.lang.Long> childrenSampleIds)
static ListSampleCriteria	createForContainer(TechId containerSampleId)
static ListSampleCriteria	createForContainers(java.util.Collection<java.lang.Long> containerSampleIds)
static ListSampleCriteria	createForExperiment(TechId experimentId)
static ListSampleCriteria	createForParent(TechId parentSampleId)
java.util.Collection<java.lang.Long>	getChildrenSampleIds()
TechId	getChildSampleId()
java.util.Collection<java.lang.Long>	getContainerSampleIds()
TechId	getExperimentId()
TechId	getParentSampleId()
SampleType	getSampleType()
java.lang.String	getSpaceCode()
boolean	isExcludeWithoutExperiment()
boolean	isIncludeInstance()
boolean	isIncludeSpace()
boolean	isOnlyDirectlyConnected()
void	setChildrenSampleIds(java.util.Collection<java.lang.Long> childrenSampleIds)
void	setExcludeWithoutExperiment(boolean excludeWithoutExperiment)
void	setIncludeInstance(boolean includeInstance)
void	setIncludeSpace(boolean includeSpace)
void	setOnlyDirectlyConnected(boolean onlyDirectlyConnected)
void	setSampleType(SampleType sampleType)
void	setSpaceCode(java.lang.String spaceCode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListSampleCriteria

public ListSampleCriteria()

Method Detail

createForContainer

public static ListSampleCriteria createForContainer(TechId containerSampleId)

createForContainers

public static ListSampleCriteria createForContainers(java.util.Collection<java.lang.Long> containerSampleIds)

createForParent

public static ListSampleCriteria createForParent(TechId parentSampleId)

createForChild

public static ListSampleCriteria createForChild(TechId childSampleId)

createForChildren

public static ListSampleCriteria createForChildren(java.util.Collection<java.lang.Long> childrenSampleIds)

createForExperiment

public static ListSampleCriteria createForExperiment(TechId experimentId)

getContainerSampleIds

public java.util.Collection<java.lang.Long> getContainerSampleIds()

getParentSampleId

public TechId getParentSampleId()

getChildSampleId

public TechId getChildSampleId()

getChildrenSampleIds

public java.util.Collection<java.lang.Long> getChildrenSampleIds()

setChildrenSampleIds

public final void setChildrenSampleIds(java.util.Collection<java.lang.Long> childrenSampleIds)

getSampleType

public SampleType getSampleType()

setSampleType

public void setSampleType(SampleType sampleType)

getSpaceCode

public java.lang.String getSpaceCode()

setSpaceCode

public void setSpaceCode(java.lang.String spaceCode)

isIncludeSpace

public boolean isIncludeSpace()

setIncludeSpace

public void setIncludeSpace(boolean includeSpace)

isIncludeInstance

public boolean isIncludeInstance()

setIncludeInstance

public void setIncludeInstance(boolean includeInstance)

isExcludeWithoutExperiment

public boolean isExcludeWithoutExperiment()

setExcludeWithoutExperiment

public void setExcludeWithoutExperiment(boolean excludeWithoutExperiment)

getExperimentId

public TechId getExperimentId()

isOnlyDirectlyConnected

public boolean isOnlyDirectlyConnected()

setOnlyDirectlyConnected

public void setOnlyDirectlyConnected(boolean onlyDirectlyConnected)