org.brapi.v2.model.geno.request

Class BrAPIReferenceSetsSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.geno.request.BrAPIReferenceSetsSearchRequest

public class BrAPIReferenceSetsSearchRequest
extends BrAPISearchRequestParametersPaging

ReferenceSetsSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPIReferenceSetsSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPIReferenceSetsSearchRequest	accession(List<String> accession)
BrAPIReferenceSetsSearchRequest	addAccessionItem(String accessionItem)
BrAPIReferenceSetsSearchRequest	addAssemblyPUIItem(String assemblyPUIItem)
BrAPIReferenceSetsSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPIReferenceSetsSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem)
BrAPIReferenceSetsSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPIReferenceSetsSearchRequest	addGermplasmDbIdsItem(String germplasmDbIdsItem)
BrAPIReferenceSetsSearchRequest	addGermplasmNamesItem(String germplasmNamesItem)
BrAPIReferenceSetsSearchRequest	addMd5checksumItem(String md5checksumItem)
BrAPIReferenceSetsSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPIReferenceSetsSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPIReferenceSetsSearchRequest	addReferenceSetDbIdsItem(String referenceSetDbIdsItem)
BrAPIReferenceSetsSearchRequest	addStudyDbIdsItem(String studyDbIdsItem)
BrAPIReferenceSetsSearchRequest	addStudyNamesItem(String studyNamesItem)
BrAPIReferenceSetsSearchRequest	addTrialDbIdsItem(String trialDbIdsItem)
BrAPIReferenceSetsSearchRequest	addTrialNamesItem(String trialNamesItem)
BrAPIReferenceSetsSearchRequest	assemblyPUI(List<String> assemblyPUI)
BrAPIReferenceSetsSearchRequest	commonCropNames(List<String> commonCropNames)
boolean	equals(Object o)
BrAPIReferenceSetsSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs)
BrAPIReferenceSetsSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
BrAPIReferenceSetsSearchRequest	germplasmDbIds(List<String> germplasmDbIds)
BrAPIReferenceSetsSearchRequest	germplasmNames(List<String> germplasmNames)
List<String>	getAccession() If set, return the reference sets for which the `accession` matches this string (case-sensitive, exact match).
List<String>	getAssemblyPUI() If set, return the reference sets for which the `assemblyId` matches this string (case-sensitive, exact match).
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>	getMd5checksum() If set, return the reference sets for which the `md5checksum` matches this string (case-sensitive, exact match).
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>	getReferenceSetDbIds() The `ReferenceSets` to search.
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()
BrAPIReferenceSetsSearchRequest	md5checksum(List<String> md5checksum)
BrAPIReferenceSetsSearchRequest	programDbIds(List<String> programDbIds)
BrAPIReferenceSetsSearchRequest	programNames(List<String> programNames)
BrAPIReferenceSetsSearchRequest	referenceSetDbIds(List<String> referenceSetDbIds)
void	setAccession(List<String> accession)
void	setAssemblyPUI(List<String> assemblyPUI)
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	setMd5checksum(List<String> md5checksum)
void	setProgramDbIds(List<String> programDbIds)
void	setProgramNames(List<String> programNames)
void	setReferenceSetDbIds(List<String> referenceSetDbIds)
void	setStudyDbIds(List<String> studyDbIds)
void	setStudyNames(List<String> studyNames)
void	setTrialDbIds(List<String> trialDbIds)
void	setTrialNames(List<String> trialNames)
BrAPIReferenceSetsSearchRequest	studyDbIds(List<String> studyDbIds)
BrAPIReferenceSetsSearchRequest	studyNames(List<String> studyNames)
String	toString()
BrAPIReferenceSetsSearchRequest	trialDbIds(List<String> trialDbIds)
BrAPIReferenceSetsSearchRequest	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

BrAPIReferenceSetsSearchRequest

public BrAPIReferenceSetsSearchRequest()

Method Detail

accession

public BrAPIReferenceSetsSearchRequest accession(List<String> accession)

addAccessionItem

public BrAPIReferenceSetsSearchRequest addAccessionItem(String accessionItem)

getAccession

public List<String> getAccession()

If set, return the reference sets for which the `accession` matches this string (case-sensitive, exact match).

Returns:

accession

setAccession

public void setAccession(List<String> accession)

assemblyPUI

public BrAPIReferenceSetsSearchRequest assemblyPUI(List<String> assemblyPUI)

addAssemblyPUIItem

public BrAPIReferenceSetsSearchRequest addAssemblyPUIItem(String assemblyPUIItem)

getAssemblyPUI

public List<String> getAssemblyPUI()

If set, return the reference sets for which the `assemblyId` matches this string (case-sensitive, exact match).

Returns:

assemblyPUI

setAssemblyPUI

public void setAssemblyPUI(List<String> assemblyPUI)

commonCropNames

public BrAPIReferenceSetsSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

public BrAPIReferenceSetsSearchRequest 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 BrAPIReferenceSetsSearchRequest externalReferenceIDs(List<String> externalReferenceIDs)

addExternalReferenceIDsItem

public BrAPIReferenceSetsSearchRequest 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 BrAPIReferenceSetsSearchRequest externalReferenceSources(List<String> externalReferenceSources)

addExternalReferenceSourcesItem

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

germplasmDbIds

public BrAPIReferenceSetsSearchRequest germplasmDbIds(List<String> germplasmDbIds)

addGermplasmDbIdsItem

public BrAPIReferenceSetsSearchRequest 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 BrAPIReferenceSetsSearchRequest germplasmNames(List<String> germplasmNames)

addGermplasmNamesItem

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

md5checksum

public BrAPIReferenceSetsSearchRequest md5checksum(List<String> md5checksum)

addMd5checksumItem

public BrAPIReferenceSetsSearchRequest addMd5checksumItem(String md5checksumItem)

getMd5checksum

public List<String> getMd5checksum()

If set, return the reference sets for which the `md5checksum` matches this string (case-sensitive, exact match).

Returns:

md5checksum

setMd5checksum

public void setMd5checksum(List<String> md5checksum)

programDbIds

public BrAPIReferenceSetsSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

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

addProgramNamesItem

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

referenceSetDbIds

public BrAPIReferenceSetsSearchRequest referenceSetDbIds(List<String> referenceSetDbIds)

addReferenceSetDbIdsItem

public BrAPIReferenceSetsSearchRequest addReferenceSetDbIdsItem(String referenceSetDbIdsItem)

getReferenceSetDbIds

public List<String> getReferenceSetDbIds()

The `ReferenceSets` to search.

Returns:

referenceSetDbIds

setReferenceSetDbIds

public void setReferenceSetDbIds(List<String> referenceSetDbIds)

studyDbIds

public BrAPIReferenceSetsSearchRequest studyDbIds(List<String> studyDbIds)

addStudyDbIdsItem

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

addStudyNamesItem

public BrAPIReferenceSetsSearchRequest 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 BrAPIReferenceSetsSearchRequest trialDbIds(List<String> trialDbIds)

addTrialDbIdsItem

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

addTrialNamesItem

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