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

Class ListOrSearchSampleCriteria

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable

public final class ListOrSearchSampleCriteria
extends ListSampleCriteria

Extended ListSampleCriteria with 2 new filter options:

• detailed sample search
• tracking new samples of particular type

Additionally one can decide if dependent samples that are loaded (parents and containers) should be enriched with properties. By default only 'primary' samples are enriched.

NOTE: This bean is not serializable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ListOrSearchSampleCriteria(ListSampleCriteria listCriteria)	Creates criteria that delegates to given ListSampleCriteria.
ListOrSearchSampleCriteria(MetaprojectCriteria metaprojectCriteria)	Creates criteria that delegates to given MetaprojectCriteria.
ListOrSearchSampleCriteria(TrackingSampleCriteria newTrackingCriteria)	Creates criteria that delegates to given TrackingSampleCriteria.
ListOrSearchSampleCriteria(java.lang.String[] codes, boolean codesArePermIds)	Creates criteria for detailed search of samples with codes.
ListOrSearchSampleCriteria(java.lang.String[] codes, boolean codesArePermIds, boolean searchForContainerSamplesOnly)	Creates criteria for detailed search of samples with codes.
ListOrSearchSampleCriteria(java.lang.String[] codes, java.lang.String[] permIds)	Creates criteria for detailed search of samples with codes.
ListOrSearchSampleCriteria(java.util.Collection<java.lang.Long> sampleIds)	Creates criteria for detailed search of samples with given ids.

Method Summary

Modifier and Type	Method	Description
java.util.Collection<java.lang.Long>	getAlreadyTrackedSampleIds()
java.util.Collection<java.lang.Long>	getChildrenSampleIds()
TechId	getChildSampleId()
java.util.Collection<java.lang.Long>	getContainerSampleIds()
TechId	getExperimentId()
java.lang.Long	getMetaprojectId()
TechId	getParentSampleId()
java.lang.String	getPropertyTypeCode()
java.lang.String	getPropertyValue()
java.util.Collection<java.lang.Long>	getSampleIds()
SampleType	getSampleType()
java.lang.String	getSampleTypeCode()
java.lang.String	getSpaceCode()
boolean	isEnrichDependentSamplesWithProperties()
boolean	isExcludeWithoutExperiment()
boolean	isIncludeInstance()
boolean	isIncludeSpace()
boolean	isOnlyDirectlyConnected()
boolean	isSearchForContainerSamplesOnly()
void	setEnrichDependentSamplesWithProperties(boolean enrichDependentSamplesWithProperties)
java.lang.String[]	trySampleCodes()
java.lang.String[]	trySamplePermIds()

Methods inherited from class ch.systemsx.cisd.openbis.generic.shared.basic.dto.ListSampleCriteria

createForChild, createForChildren, createForContainer, createForContainers, createForExperiment, createForParent, setChildrenSampleIds, setExcludeWithoutExperiment, setIncludeInstance, setIncludeSpace, setOnlyDirectlyConnected, setSampleType, setSpaceCode

Methods inherited from class java.lang.Object

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

Constructor Detail

ListOrSearchSampleCriteria

public ListOrSearchSampleCriteria(ListSampleCriteria listCriteria)

Creates criteria that delegates to given ListSampleCriteria.

ListOrSearchSampleCriteria

public ListOrSearchSampleCriteria(TrackingSampleCriteria newTrackingCriteria)

Creates criteria that delegates to given TrackingSampleCriteria.

ListOrSearchSampleCriteria

public ListOrSearchSampleCriteria(MetaprojectCriteria metaprojectCriteria)

Creates criteria that delegates to given MetaprojectCriteria.

ListOrSearchSampleCriteria

public ListOrSearchSampleCriteria(java.util.Collection<java.lang.Long> sampleIds)

Creates criteria for detailed search of samples with given ids.

ListOrSearchSampleCriteria

public ListOrSearchSampleCriteria(java.lang.String[] codes,
                                  boolean codesArePermIds)

Creates criteria for detailed search of samples with codes.

ListOrSearchSampleCriteria

public ListOrSearchSampleCriteria(java.lang.String[] codes,
                                  boolean codesArePermIds,
                                  boolean searchForContainerSamplesOnly)

Creates criteria for detailed search of samples with codes.

ListOrSearchSampleCriteria

public ListOrSearchSampleCriteria(java.lang.String[] codes,
                                  java.lang.String[] permIds)

Creates criteria for detailed search of samples with codes.

Method Detail

getSampleIds

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

trySampleCodes

public java.lang.String[] trySampleCodes()

trySamplePermIds

public java.lang.String[] trySamplePermIds()

getSampleTypeCode

public java.lang.String getSampleTypeCode()

getPropertyTypeCode

public java.lang.String getPropertyTypeCode()

getPropertyValue

public java.lang.String getPropertyValue()

getAlreadyTrackedSampleIds

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

getMetaprojectId

public java.lang.Long getMetaprojectId()

getContainerSampleIds

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

Overrides:

getContainerSampleIds in class ListSampleCriteria

getParentSampleId

public TechId getParentSampleId()

Overrides:

getParentSampleId in class ListSampleCriteria

getChildSampleId

public TechId getChildSampleId()

Overrides:

getChildSampleId in class ListSampleCriteria

isOnlyDirectlyConnected

public boolean isOnlyDirectlyConnected()

Overrides:

isOnlyDirectlyConnected in class ListSampleCriteria

getChildrenSampleIds

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

Overrides:

getChildrenSampleIds in class ListSampleCriteria

getExperimentId

public TechId getExperimentId()

Overrides:

getExperimentId in class ListSampleCriteria

getSpaceCode

public java.lang.String getSpaceCode()

Overrides:

getSpaceCode in class ListSampleCriteria

getSampleType

public SampleType getSampleType()

Overrides:

getSampleType in class ListSampleCriteria

isExcludeWithoutExperiment

public boolean isExcludeWithoutExperiment()

Overrides:

isExcludeWithoutExperiment in class ListSampleCriteria

isIncludeSpace

public boolean isIncludeSpace()

Overrides:

isIncludeSpace in class ListSampleCriteria

isIncludeInstance

public boolean isIncludeInstance()

Overrides:

isIncludeInstance in class ListSampleCriteria

isEnrichDependentSamplesWithProperties

public boolean isEnrichDependentSamplesWithProperties()

setEnrichDependentSamplesWithProperties

public void setEnrichDependentSamplesWithProperties(boolean enrichDependentSamplesWithProperties)

isSearchForContainerSamplesOnly

public boolean isSearchForContainerSamplesOnly()