org.brapi.v2.model.geno.request

Class BrAPIPlateSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.geno.request.BrAPIPlateSearchRequest

public class BrAPIPlateSearchRequest
extends BrAPISearchRequestParametersPaging

PlateSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPIPlateSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPIPlateSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPIPlateSearchRequest	addExternalReferenceIdsItem(String externalReferenceIdsItem)
BrAPIPlateSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem)
BrAPIPlateSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPIPlateSearchRequest	addGermplasmDbIdsItem(String germplasmDbIdsItem)
BrAPIPlateSearchRequest	addGermplasmNamesItem(String germplasmNamesItem)
BrAPIPlateSearchRequest	addObservationUnitDbIdsItem(String observationUnitDbIdsItem)
BrAPIPlateSearchRequest	addPlateBarcodesItem(String plateBarcodesItem)
BrAPIPlateSearchRequest	addPlateDbIdsItem(String plateDbIdsItem)
BrAPIPlateSearchRequest	addPlateNamesItem(String plateNamesItem)
BrAPIPlateSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPIPlateSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPIPlateSearchRequest	addSampleDbIdsItem(String sampleDbIdsItem)
BrAPIPlateSearchRequest	addSampleGroupDbIdsItem(String sampleGroupDbIdsItem)
BrAPIPlateSearchRequest	addSampleNamesItem(String sampleNamesItem)
BrAPIPlateSearchRequest	addStudyDbIdsItem(String studyDbIdsItem)
BrAPIPlateSearchRequest	addStudyNamesItem(String studyNamesItem)
BrAPIPlateSearchRequest	addTrialDbIdsItem(String trialDbIdsItem)
BrAPIPlateSearchRequest	addTrialNamesItem(String trialNamesItem)
BrAPIPlateSearchRequest	commonCropNames(List<String> commonCropNames)
boolean	equals(Object o)
BrAPIPlateSearchRequest	externalReferenceIds(List<String> externalReferenceIds)
BrAPIPlateSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs)
BrAPIPlateSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
BrAPIPlateSearchRequest	germplasmDbIds(List<String> germplasmDbIds)
BrAPIPlateSearchRequest	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 reference IDs.
List<String>	getExternalReferenceIDs() **Deprecated in v2.1** Please use `externalReferenceIds`.
List<String>	getExternalReferenceSources() List of identifiers for the source system or database of an external reference (use with `externalReferenceIDs` parameter)
List<String>	getGermplasmDbIds() The ID which uniquely identifies a germplasm
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>	getPlateBarcodes() A unique identifier physically attached to the plate
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()
BrAPIPlateSearchRequest	observationUnitDbIds(List<String> observationUnitDbIds)
BrAPIPlateSearchRequest	page(Integer page)
BrAPIPlateSearchRequest	pageSize(Integer pageSize)
BrAPIPlateSearchRequest	plateBarcodes(List<String> plateBarcodes)
BrAPIPlateSearchRequest	plateDbIds(List<String> plateDbIds)
BrAPIPlateSearchRequest	plateNames(List<String> plateNames)
BrAPIPlateSearchRequest	programDbIds(List<String> programDbIds)
BrAPIPlateSearchRequest	programNames(List<String> programNames)
BrAPIPlateSearchRequest	sampleDbIds(List<String> sampleDbIds)
BrAPIPlateSearchRequest	sampleGroupDbIds(List<String> sampleGroupDbIds)
BrAPIPlateSearchRequest	sampleNames(List<String> sampleNames)
void	setCommonCropNames(List<String> commonCropNames)
void	setExternalReferenceIds(List<String> externalReferenceIds)
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	setPlateBarcodes(List<String> plateBarcodes)
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)
BrAPIPlateSearchRequest	studyDbIds(List<String> studyDbIds)
BrAPIPlateSearchRequest	studyNames(List<String> studyNames)
String	toString()
BrAPIPlateSearchRequest	trialDbIds(List<String> trialDbIds)
BrAPIPlateSearchRequest	trialNames(List<String> trialNames)

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

getPage, getPageSize, setPage, setPageSize

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIPlateSearchRequest

public BrAPIPlateSearchRequest()

Method Detail

commonCropNames

public BrAPIPlateSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

public BrAPIPlateSearchRequest 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)

externalReferenceIDs

public BrAPIPlateSearchRequest externalReferenceIDs(List<String> externalReferenceIDs)

addExternalReferenceIDsItem

public BrAPIPlateSearchRequest addExternalReferenceIDsItem(String externalReferenceIDsItem)

getExternalReferenceIDs

public List<String> getExternalReferenceIDs()

**Deprecated in v2.1** Please use `externalReferenceIds`. Github issue number #460 <br>List of external reference IDs. Could be a simple strings or a URIs. (use with `externalReferenceSources` parameter)

Returns:

externalReferenceIDs

setExternalReferenceIDs

public void setExternalReferenceIDs(List<String> externalReferenceIDs)

externalReferenceIds

public BrAPIPlateSearchRequest externalReferenceIds(List<String> externalReferenceIds)

addExternalReferenceIdsItem

public BrAPIPlateSearchRequest addExternalReferenceIdsItem(String externalReferenceIdsItem)

getExternalReferenceIds

public List<String> getExternalReferenceIds()

List of external reference IDs. Could be a simple strings or a URIs. (use with `externalReferenceSources` parameter)

Returns:

externalReferenceIds

setExternalReferenceIds

public void setExternalReferenceIds(List<String> externalReferenceIds)

externalReferenceSources

public BrAPIPlateSearchRequest externalReferenceSources(List<String> externalReferenceSources)

addExternalReferenceSourcesItem

public BrAPIPlateSearchRequest addExternalReferenceSourcesItem(String externalReferenceSourcesItem)

getExternalReferenceSources

public List<String> getExternalReferenceSources()

List of identifiers for the source system or database of an external reference (use with `externalReferenceIDs` parameter)

Returns:

externalReferenceSources

setExternalReferenceSources

public void setExternalReferenceSources(List<String> externalReferenceSources)

germplasmDbIds

public BrAPIPlateSearchRequest germplasmDbIds(List<String> germplasmDbIds)

addGermplasmDbIdsItem

public BrAPIPlateSearchRequest addGermplasmDbIdsItem(String germplasmDbIdsItem)

getGermplasmDbIds

public List<String> getGermplasmDbIds()

The ID which uniquely identifies a germplasm

Returns:

germplasmDbIds

setGermplasmDbIds

public void setGermplasmDbIds(List<String> germplasmDbIds)

germplasmNames

public BrAPIPlateSearchRequest germplasmNames(List<String> germplasmNames)

addGermplasmNamesItem

public BrAPIPlateSearchRequest 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)

observationUnitDbIds

public BrAPIPlateSearchRequest observationUnitDbIds(List<String> observationUnitDbIds)

addObservationUnitDbIdsItem

public BrAPIPlateSearchRequest 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)

page

public BrAPIPlateSearchRequest page(Integer page)

Overrides:

page in class BrAPISearchRequestParametersPaging

pageSize

public BrAPIPlateSearchRequest pageSize(Integer pageSize)

Overrides:

pageSize in class BrAPISearchRequestParametersPaging

plateBarcodes

public BrAPIPlateSearchRequest plateBarcodes(List<String> plateBarcodes)

addPlateBarcodesItem

public BrAPIPlateSearchRequest addPlateBarcodesItem(String plateBarcodesItem)

getPlateBarcodes

public List<String> getPlateBarcodes()

A unique identifier physically attached to the plate

Returns:

plateBarcodes

setPlateBarcodes

public void setPlateBarcodes(List<String> plateBarcodes)

plateDbIds

public BrAPIPlateSearchRequest plateDbIds(List<String> plateDbIds)

addPlateDbIdsItem

public BrAPIPlateSearchRequest 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 BrAPIPlateSearchRequest plateNames(List<String> plateNames)

addPlateNamesItem

public BrAPIPlateSearchRequest 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 BrAPIPlateSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

public BrAPIPlateSearchRequest 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 BrAPIPlateSearchRequest programNames(List<String> programNames)

addProgramNamesItem

public BrAPIPlateSearchRequest 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 BrAPIPlateSearchRequest sampleDbIds(List<String> sampleDbIds)

addSampleDbIdsItem

public BrAPIPlateSearchRequest 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 BrAPIPlateSearchRequest sampleGroupDbIds(List<String> sampleGroupDbIds)

addSampleGroupDbIdsItem

public BrAPIPlateSearchRequest 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 BrAPIPlateSearchRequest sampleNames(List<String> sampleNames)

addSampleNamesItem

public BrAPIPlateSearchRequest addSampleNamesItem(String sampleNamesItem)

getSampleNames

public List<String> getSampleNames()

The human readable name of the sample

Returns:

sampleNames

setSampleNames

public void setSampleNames(List<String> sampleNames)

studyDbIds

public BrAPIPlateSearchRequest studyDbIds(List<String> studyDbIds)

addStudyDbIdsItem

public BrAPIPlateSearchRequest 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 BrAPIPlateSearchRequest studyNames(List<String> studyNames)

addStudyNamesItem

public BrAPIPlateSearchRequest 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)

trialDbIds

public BrAPIPlateSearchRequest trialDbIds(List<String> trialDbIds)

addTrialDbIdsItem

public BrAPIPlateSearchRequest 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 BrAPIPlateSearchRequest trialNames(List<String> trialNames)

addTrialNamesItem

public BrAPIPlateSearchRequest 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