org.brapi.v2.model.geno.request

Class BrAPIVariantSetsSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.geno.request.BrAPIVariantSetsSearchRequest

public class BrAPIVariantSetsSearchRequest
extends BrAPISearchRequestParametersPaging

VariantSetsSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPIVariantSetsSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPIVariantSetsSearchRequest	addCallSetDbIdsItem(String callSetDbIdsItem)
BrAPIVariantSetsSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPIVariantSetsSearchRequest	addExternalReferenceIdsItem(String externalReferenceIdsItem)
BrAPIVariantSetsSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem)
BrAPIVariantSetsSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPIVariantSetsSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPIVariantSetsSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPIVariantSetsSearchRequest	addReferenceDbIdsItem(String referenceDbIdsItem)
BrAPIVariantSetsSearchRequest	addReferenceSetDbIdsItem(String referenceSetDbIdsItem)
BrAPIVariantSetsSearchRequest	addStudyDbIdsItem(String studyDbIdsItem)
BrAPIVariantSetsSearchRequest	addStudyNamesItem(String studyNamesItem)
BrAPIVariantSetsSearchRequest	addTrialDbIdsItem(String trialDbIdsItem)
BrAPIVariantSetsSearchRequest	addTrialNamesItem(String trialNamesItem)
BrAPIVariantSetsSearchRequest	addVariantDbIdsItem(String variantDbIdsItem)
BrAPIVariantSetsSearchRequest	addVariantSetDbIdsItem(String variantSetDbIdsItem)
BrAPIVariantSetsSearchRequest	callSetDbIds(List<String> callSetDbIds)
BrAPIVariantSetsSearchRequest	commonCropNames(List<String> commonCropNames)
boolean	equals(Object o)
BrAPIVariantSetsSearchRequest	externalReferenceIds(List<String> externalReferenceIds)
BrAPIVariantSetsSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs)
BrAPIVariantSetsSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
List<String>	getCallSetDbIds() The CallSet to search.
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>	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>	getReferenceDbIds() The unique identifier representing a genotype Reference
List<String>	getReferenceSetDbIds() The unique identifier representing a genotype ReferenceSet
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
List<String>	getVariantDbIds() The Variant to search.
List<String>	getVariantSetDbIds() The VariantSet to search.
int	hashCode()
BrAPIVariantSetsSearchRequest	programDbIds(List<String> programDbIds)
BrAPIVariantSetsSearchRequest	programNames(List<String> programNames)
BrAPIVariantSetsSearchRequest	referenceDbIds(List<String> referenceDbIds)
BrAPIVariantSetsSearchRequest	referenceSetDbIds(List<String> referenceSetDbIds)
void	setCallSetDbIds(List<String> callSetDbIds)
void	setCommonCropNames(List<String> commonCropNames)
void	setExternalReferenceIds(List<String> externalReferenceIds)
void	setExternalReferenceIDs(List<String> externalReferenceIDs)
void	setExternalReferenceSources(List<String> externalReferenceSources)
void	setProgramDbIds(List<String> programDbIds)
void	setProgramNames(List<String> programNames)
void	setReferenceDbIds(List<String> referenceDbIds)
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)
void	setVariantDbIds(List<String> variantDbIds)
void	setVariantSetDbIds(List<String> variantSetDbIds)
BrAPIVariantSetsSearchRequest	studyDbIds(List<String> studyDbIds)
BrAPIVariantSetsSearchRequest	studyNames(List<String> studyNames)
String	toString()
BrAPIVariantSetsSearchRequest	trialDbIds(List<String> trialDbIds)
BrAPIVariantSetsSearchRequest	trialNames(List<String> trialNames)
BrAPIVariantSetsSearchRequest	variantDbIds(List<String> variantDbIds)
BrAPIVariantSetsSearchRequest	variantSetDbIds(List<String> variantSetDbIds)

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

BrAPIVariantSetsSearchRequest

public BrAPIVariantSetsSearchRequest()

Method Detail

commonCropNames

public BrAPIVariantSetsSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

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

addExternalReferenceIDsItem

public BrAPIVariantSetsSearchRequest 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 BrAPIVariantSetsSearchRequest externalReferenceIds(List<String> externalReferenceIds)

addExternalReferenceIdsItem

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

addExternalReferenceSourcesItem

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

programDbIds

public BrAPIVariantSetsSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

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

addProgramNamesItem

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

referenceDbIds

public BrAPIVariantSetsSearchRequest referenceDbIds(List<String> referenceDbIds)

addReferenceDbIdsItem

public BrAPIVariantSetsSearchRequest addReferenceDbIdsItem(String referenceDbIdsItem)

getReferenceDbIds

public List<String> getReferenceDbIds()

The unique identifier representing a genotype Reference

Returns:

referenceDbIds

setReferenceDbIds

public void setReferenceDbIds(List<String> referenceDbIds)

referenceSetDbIds

public BrAPIVariantSetsSearchRequest referenceSetDbIds(List<String> referenceSetDbIds)

addReferenceSetDbIdsItem

public BrAPIVariantSetsSearchRequest addReferenceSetDbIdsItem(String referenceSetDbIdsItem)

getReferenceSetDbIds

public List<String> getReferenceSetDbIds()

The unique identifier representing a genotype ReferenceSet

Returns:

referenceSetDbIds

setReferenceSetDbIds

public void setReferenceSetDbIds(List<String> referenceSetDbIds)

studyDbIds

public BrAPIVariantSetsSearchRequest studyDbIds(List<String> studyDbIds)

addStudyDbIdsItem

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

addStudyNamesItem

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

callSetDbIds

public BrAPIVariantSetsSearchRequest callSetDbIds(List<String> callSetDbIds)

addCallSetDbIdsItem

public BrAPIVariantSetsSearchRequest addCallSetDbIdsItem(String callSetDbIdsItem)

getCallSetDbIds

public List<String> getCallSetDbIds()

The CallSet to search.

Returns:

callSetDbIds

setCallSetDbIds

public void setCallSetDbIds(List<String> callSetDbIds)

trialDbIds

public BrAPIVariantSetsSearchRequest trialDbIds(List<String> trialDbIds)

addTrialDbIdsItem

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

addTrialNamesItem

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

variantDbIds

public BrAPIVariantSetsSearchRequest variantDbIds(List<String> variantDbIds)

addVariantDbIdsItem

public BrAPIVariantSetsSearchRequest addVariantDbIdsItem(String variantDbIdsItem)

getVariantDbIds

public List<String> getVariantDbIds()

The Variant to search.

Returns:

variantDbIds

setVariantDbIds

public void setVariantDbIds(List<String> variantDbIds)

variantSetDbIds

public BrAPIVariantSetsSearchRequest variantSetDbIds(List<String> variantSetDbIds)

addVariantSetDbIdsItem

public BrAPIVariantSetsSearchRequest addVariantSetDbIdsItem(String variantSetDbIdsItem)

getVariantSetDbIds

public List<String> getVariantSetDbIds()

The VariantSet to search.

Returns:

variantSetDbIds

setVariantSetDbIds

public void setVariantSetDbIds(List<String> variantSetDbIds)

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