org.brapi.v2.model.geno.request

Class BrAPISampleSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.geno.request.BrAPISampleSearchRequest

public class BrAPISampleSearchRequest
extends BrAPISearchRequestParametersPaging

SampleSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPISampleSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPISampleSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPISampleSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem)
BrAPISampleSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPISampleSearchRequest	addGermplasmDbIdsItem(String germplasmDbIdsItem)
BrAPISampleSearchRequest	addGermplasmNamesItem(String germplasmNamesItem)
BrAPISampleSearchRequest	addObservationUnitDbIdsItem(String observationUnitDbIdsItem)
BrAPISampleSearchRequest	addPlateDbIdsItem(String plateDbIdsItem)
BrAPISampleSearchRequest	addPlateNamesItem(String plateNamesItem)
BrAPISampleSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPISampleSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPISampleSearchRequest	addSampleDbIdsItem(String sampleDbIdsItem)
BrAPISampleSearchRequest	addSampleGroupDbIdsItem(String sampleGroupDbIdsItem)
BrAPISampleSearchRequest	addSampleNamesItem(String sampleNamesItem)
BrAPISampleSearchRequest	addStudyDbIdsItem(String studyDbIdsItem)
BrAPISampleSearchRequest	addStudyNamesItem(String studyNamesItem)
BrAPISampleSearchRequest	addTrialDbIdsItem(String trialDbIdsItem)
BrAPISampleSearchRequest	addTrialNamesItem(String trialNamesItem)
BrAPISampleSearchRequest	commonCropNames(List<String> commonCropNames)
boolean	equals(Object o)
BrAPISampleSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs)
BrAPISampleSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
BrAPISampleSearchRequest	germplasmDbIds(List<String> germplasmDbIds)
BrAPISampleSearchRequest	germplasmNames(List<String> germplasmNames)
List<String>	getCommonCropNames() The BrAPI Common Crop Name is the simple, generalized, widely accepted name of the organism being researched.
List<String>	getExternalReferenceIDs() List of external references for the trait to search for
List<String>	getExternalReferenceSources() List of external references sources for the trait to search for
List<String>	getGermplasmDbIds() List of IDs which uniquely identify germplasm to search for
List<String>	getGermplasmNames() List of human readable names to identify germplasm to search for
List<String>	getObservationUnitDbIds() The ID which uniquely identifies an observation unit
List<String>	getPlateDbIds() The ID which uniquely identifies a plate of samples
List<String>	getPlateNames() The human readable name of a `Plate` of `Samples`
List<String>	getProgramDbIds() A BrAPI Program represents the high level organization or group who is responsible for conducting trials and studies.
List<String>	getProgramNames() Use this parameter to only return results associated with the given program names.
List<String>	getSampleDbIds() The ID which uniquely identifies a sample
List<String>	getSampleGroupDbIds() The unique identifier for a group of related `Samples`
List<String>	getSampleNames() The human readable name of the `Sample`
List<String>	getStudyDbIds() List of study identifiers to search for
List<String>	getStudyNames() List of study names to filter search results
List<String>	getTrialDbIds() The ID which uniquely identifies a trial to search for
List<String>	getTrialNames() The human readable name of a trial to search for
int	hashCode()
BrAPISampleSearchRequest	observationUnitDbIds(List<String> observationUnitDbIds)
BrAPISampleSearchRequest	plateDbIds(List<String> plateDbIds)
BrAPISampleSearchRequest	plateNames(List<String> plateNames)
BrAPISampleSearchRequest	programDbIds(List<String> programDbIds)
BrAPISampleSearchRequest	programNames(List<String> programNames)
BrAPISampleSearchRequest	sampleDbIds(List<String> sampleDbIds)
BrAPISampleSearchRequest	sampleGroupDbIds(List<String> sampleGroupDbIds)
BrAPISampleSearchRequest	sampleNames(List<String> sampleNames)
void	setCommonCropNames(List<String> commonCropNames)
void	setExternalReferenceIDs(List<String> externalReferenceIDs)
void	setExternalReferenceSources(List<String> externalReferenceSources)
void	setGermplasmDbIds(List<String> germplasmDbIds)
void	setGermplasmNames(List<String> germplasmNames)
void	setObservationUnitDbIds(List<String> observationUnitDbIds)
void	setPlateDbIds(List<String> plateDbIds)
void	setPlateNames(List<String> plateNames)
void	setProgramDbIds(List<String> programDbIds)
void	setProgramNames(List<String> programNames)
void	setSampleDbIds(List<String> sampleDbIds)
void	setSampleGroupDbIds(List<String> sampleGroupDbIds)
void	setSampleNames(List<String> sampleNames)
void	setStudyDbIds(List<String> studyDbIds)
void	setStudyNames(List<String> studyNames)
void	setTrialDbIds(List<String> trialDbIds)
void	setTrialNames(List<String> trialNames)
BrAPISampleSearchRequest	studyDbIds(List<String> studyDbIds)
BrAPISampleSearchRequest	studyNames(List<String> studyNames)
String	toString()
BrAPISampleSearchRequest	trialDbIds(List<String> trialDbIds)
BrAPISampleSearchRequest	trialNames(List<String> trialNames)

Methods inherited from class org.brapi.v2.model.BrAPISearchRequestParametersPaging

getPage, getPageSize, page, pageSize, setPage, setPageSize

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPISampleSearchRequest

public BrAPISampleSearchRequest()

Method Detail

commonCropNames

public BrAPISampleSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

public BrAPISampleSearchRequest addCommonCropNamesItem(String commonCropNamesItem)

getCommonCropNames

public List<String> getCommonCropNames()

The BrAPI Common Crop Name is the simple, generalized, widely accepted name of the organism being researched. It is most often used in multi-crop systems where digital resources need to be divided at a high level. Things like 'Maize', 'Wheat', and 'Rice' are examples of common crop names. Use this parameter to only return results associated with the given crops. Use `GET /commoncropnames` to find the list of available crops on a server.

Returns:

commonCropNames

setCommonCropNames

public void setCommonCropNames(List<String> commonCropNames)

germplasmDbIds

public BrAPISampleSearchRequest germplasmDbIds(List<String> germplasmDbIds)

addGermplasmDbIdsItem

public BrAPISampleSearchRequest addGermplasmDbIdsItem(String germplasmDbIdsItem)

getGermplasmDbIds

public List<String> getGermplasmDbIds()

List of IDs which uniquely identify germplasm to search for

Returns:

germplasmDbIds

setGermplasmDbIds

public void setGermplasmDbIds(List<String> germplasmDbIds)

germplasmNames

public BrAPISampleSearchRequest germplasmNames(List<String> germplasmNames)

addGermplasmNamesItem

public BrAPISampleSearchRequest addGermplasmNamesItem(String germplasmNamesItem)

getGermplasmNames

public List<String> getGermplasmNames()

List of human readable names to identify germplasm to search for

Returns:

germplasmNames

setGermplasmNames

public void setGermplasmNames(List<String> germplasmNames)

studyDbIds

public BrAPISampleSearchRequest studyDbIds(List<String> studyDbIds)

addStudyDbIdsItem

public BrAPISampleSearchRequest addStudyDbIdsItem(String studyDbIdsItem)

getStudyDbIds

public List<String> getStudyDbIds()

List of study identifiers to search for

Returns:

studyDbIds

setStudyDbIds

public void setStudyDbIds(List<String> studyDbIds)

studyNames

public BrAPISampleSearchRequest studyNames(List<String> studyNames)

addStudyNamesItem

public BrAPISampleSearchRequest addStudyNamesItem(String studyNamesItem)

getStudyNames

public List<String> getStudyNames()

List of study names to filter search results

Returns:

studyNames

setStudyNames

public void setStudyNames(List<String> studyNames)

externalReferenceIDs

public BrAPISampleSearchRequest externalReferenceIDs(List<String> externalReferenceIDs)

addExternalReferenceIDsItem

public BrAPISampleSearchRequest addExternalReferenceIDsItem(String externalReferenceIDsItem)

getExternalReferenceIDs

public List<String> getExternalReferenceIDs()

List of external references for the trait to search for

Returns:

externalReferenceIDs

setExternalReferenceIDs

public void setExternalReferenceIDs(List<String> externalReferenceIDs)

externalReferenceSources

public BrAPISampleSearchRequest externalReferenceSources(List<String> externalReferenceSources)

addExternalReferenceSourcesItem

public BrAPISampleSearchRequest addExternalReferenceSourcesItem(String externalReferenceSourcesItem)

getExternalReferenceSources

public List<String> getExternalReferenceSources()

List of external references sources for the trait to search for

Returns:

externalReferenceSources

setExternalReferenceSources

public void setExternalReferenceSources(List<String> externalReferenceSources)

observationUnitDbIds

public BrAPISampleSearchRequest observationUnitDbIds(List<String> observationUnitDbIds)

addObservationUnitDbIdsItem

public BrAPISampleSearchRequest addObservationUnitDbIdsItem(String observationUnitDbIdsItem)

getObservationUnitDbIds

public List<String> getObservationUnitDbIds()

The ID which uniquely identifies an observation unit

Returns:

observationUnitDbIds

setObservationUnitDbIds

public void setObservationUnitDbIds(List<String> observationUnitDbIds)

plateDbIds

public BrAPISampleSearchRequest plateDbIds(List<String> plateDbIds)

addPlateDbIdsItem

public BrAPISampleSearchRequest addPlateDbIdsItem(String plateDbIdsItem)

getPlateDbIds

public List<String> getPlateDbIds()

The ID which uniquely identifies a plate of samples

Returns:

plateDbIds

setPlateDbIds

public void setPlateDbIds(List<String> plateDbIds)

plateNames

public BrAPISampleSearchRequest plateNames(List<String> plateNames)

addPlateNamesItem

public BrAPISampleSearchRequest addPlateNamesItem(String plateNamesItem)

getPlateNames

public List<String> getPlateNames()

The human readable name of a `Plate` of `Samples`

Returns:

plateNames

setPlateNames

public void setPlateNames(List<String> plateNames)

programDbIds

public BrAPISampleSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

public BrAPISampleSearchRequest addProgramDbIdsItem(String programDbIdsItem)

getProgramDbIds

public List<String> getProgramDbIds()

A BrAPI Program represents the high level organization or group who is responsible for conducting trials and studies. Things like Breeding Programs and Funded Projects are considered BrAPI Programs. Use this parameter to only return results associated with the given programs. Use `GET /programs` to find the list of available programs on a server.

Returns:

programDbIds

setProgramDbIds

public void setProgramDbIds(List<String> programDbIds)

programNames

public BrAPISampleSearchRequest programNames(List<String> programNames)

addProgramNamesItem

public BrAPISampleSearchRequest addProgramNamesItem(String programNamesItem)

getProgramNames

public List<String> getProgramNames()

Use this parameter to only return results associated with the given program names. Program names are not required to be unique. Use `GET /programs` to find the list of available programs on a server.

Returns:

programNames

setProgramNames

public void setProgramNames(List<String> programNames)

sampleDbIds

public BrAPISampleSearchRequest sampleDbIds(List<String> sampleDbIds)

addSampleDbIdsItem

public BrAPISampleSearchRequest addSampleDbIdsItem(String sampleDbIdsItem)

getSampleDbIds

public List<String> getSampleDbIds()

The ID which uniquely identifies a sample

Returns:

sampleDbIds

setSampleDbIds

public void setSampleDbIds(List<String> sampleDbIds)

sampleGroupDbIds

public BrAPISampleSearchRequest sampleGroupDbIds(List<String> sampleGroupDbIds)

addSampleGroupDbIdsItem

public BrAPISampleSearchRequest addSampleGroupDbIdsItem(String sampleGroupDbIdsItem)

getSampleGroupDbIds

public List<String> getSampleGroupDbIds()

The unique identifier for a group of related `Samples`

Returns:

sampleGroupDbIds

setSampleGroupDbIds

public void setSampleGroupDbIds(List<String> sampleGroupDbIds)

sampleNames

public BrAPISampleSearchRequest sampleNames(List<String> sampleNames)

addSampleNamesItem

public BrAPISampleSearchRequest addSampleNamesItem(String sampleNamesItem)

getSampleNames

public List<String> getSampleNames()

The human readable name of the `Sample`

Returns:

sampleNames

setSampleNames

public void setSampleNames(List<String> sampleNames)

trialDbIds

public BrAPISampleSearchRequest trialDbIds(List<String> trialDbIds)

addTrialDbIdsItem

public BrAPISampleSearchRequest addTrialDbIdsItem(String trialDbIdsItem)

getTrialDbIds

public List<String> getTrialDbIds()

The ID which uniquely identifies a trial to search for

Returns:

trialDbIds

setTrialDbIds

public void setTrialDbIds(List<String> trialDbIds)

trialNames

public BrAPISampleSearchRequest trialNames(List<String> trialNames)

addTrialNamesItem

public BrAPISampleSearchRequest addTrialNamesItem(String trialNamesItem)

getTrialNames

public List<String> getTrialNames()

The human readable name of a trial to search for

Returns:

trialNames

setTrialNames

public void setTrialNames(List<String> trialNames)

equals

public boolean equals(Object o)

Overrides:

equals in class BrAPISearchRequestParametersPaging

hashCode

public int hashCode()

Overrides:

hashCode in class BrAPISearchRequestParametersPaging

toString

public String toString()

Overrides:

toString in class BrAPISearchRequestParametersPaging