org.brapi.v2.model.geno.request

Class BrAPICallSetsSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.geno.request.BrAPICallSetsSearchRequest

public class BrAPICallSetsSearchRequest
extends BrAPISearchRequestParametersPaging

CallSetsSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPICallSetsSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPICallSetsSearchRequest	addCallSetDbIdsItem(String callSetDbIdsItem)
BrAPICallSetsSearchRequest	addCallSetNamesItem(String callSetNamesItem)
BrAPICallSetsSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPICallSetsSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem)
BrAPICallSetsSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPICallSetsSearchRequest	addGermplasmDbIdsItem(String germplasmDbIdsItem)
BrAPICallSetsSearchRequest	addGermplasmNamesItem(String germplasmNamesItem)
BrAPICallSetsSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPICallSetsSearchRequest	addSampleDbIdsItem(String sampleDbIdsItem)
BrAPICallSetsSearchRequest	addSampleNamesItem(String sampleNamesItem)
BrAPICallSetsSearchRequest	addStudyDbIdsItem(String studyDbIdsItem)
BrAPICallSetsSearchRequest	addStudyNamesItem(String studyNamesItem)
BrAPICallSetsSearchRequest	addTrialDbIdsItem(String trialDbIdsItem)
BrAPICallSetsSearchRequest	addTrialNamesItem(String trialNamesItem)
BrAPICallSetsSearchRequest	addVariantSetDbIdsItem(String variantSetDbIdsItem)
BrAPICallSetsSearchRequest	callSetDbIds(List<String> callSetDbIds)
BrAPICallSetsSearchRequest	callSetNames(List<String> callSetNames)
BrAPICallSetsSearchRequest	commonCropNames(List<String> commonCropNames)
boolean	equals(Object o)
BrAPICallSetsSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs)
BrAPICallSetsSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
BrAPICallSetsSearchRequest	germplasmDbIds(List<String> germplasmDbIds)
BrAPICallSetsSearchRequest	germplasmNames(List<String> germplasmNames)
List<String>	getCallSetDbIds() Only return call sets with these DbIds (case-sensitive, exact match).
List<String>	getCallSetNames() Only return call sets with these names (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>	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() Return only call sets generated from the provided Biosample IDs.
List<String>	getSampleNames() Return only call sets generated from the provided Biosample human readable names.
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>	getVariantSetDbIds() The VariantSet to search.
int	hashCode()
BrAPICallSetsSearchRequest	programNames(List<String> programNames)
BrAPICallSetsSearchRequest	sampleDbIds(List<String> sampleDbIds)
BrAPICallSetsSearchRequest	sampleNames(List<String> sampleNames)
void	setCallSetDbIds(List<String> callSetDbIds)
void	setCallSetNames(List<String> callSetNames)
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	setProgramDbIds(List<String> programDbIds)
void	setProgramNames(List<String> programNames)
void	setSampleDbIds(List<String> sampleDbIds)
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)
void	setVariantSetDbIds(List<String> variantSetDbIds)
BrAPICallSetsSearchRequest	studyDbIds(List<String> studyDbIds)
BrAPICallSetsSearchRequest	studyNames(List<String> studyNames)
String	toString()
BrAPICallSetsSearchRequest	trialDbIds(List<String> trialDbIds)
BrAPICallSetsSearchRequest	trialNames(List<String> trialNames)
BrAPICallSetsSearchRequest	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

BrAPICallSetsSearchRequest

public BrAPICallSetsSearchRequest()

Method Detail

germplasmDbIds

public BrAPICallSetsSearchRequest germplasmDbIds(List<String> germplasmDbIds)

addGermplasmDbIdsItem

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

addGermplasmNamesItem

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

callSetDbIds

public BrAPICallSetsSearchRequest callSetDbIds(List<String> callSetDbIds)

addCallSetDbIdsItem

public BrAPICallSetsSearchRequest addCallSetDbIdsItem(String callSetDbIdsItem)

getCallSetDbIds

public List<String> getCallSetDbIds()

Only return call sets with these DbIds (case-sensitive, exact match).

Returns:

callSetDbIds

setCallSetDbIds

public void setCallSetDbIds(List<String> callSetDbIds)

callSetNames

public BrAPICallSetsSearchRequest callSetNames(List<String> callSetNames)

addCallSetNamesItem

public BrAPICallSetsSearchRequest addCallSetNamesItem(String callSetNamesItem)

getCallSetNames

public List<String> getCallSetNames()

Only return call sets with these names (case-sensitive, exact match).

Returns:

callSetNames

setCallSetNames

public void setCallSetNames(List<String> callSetNames)

commonCropNames

public BrAPICallSetsSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

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

addExternalReferenceIDsItem

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

addExternalReferenceSourcesItem

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

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

addProgramNamesItem

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

addSampleDbIdsItem

public BrAPICallSetsSearchRequest addSampleDbIdsItem(String sampleDbIdsItem)

getSampleDbIds

public List<String> getSampleDbIds()

Return only call sets generated from the provided Biosample IDs.

Returns:

sampleDbIds

setSampleDbIds

public void setSampleDbIds(List<String> sampleDbIds)

sampleNames

public BrAPICallSetsSearchRequest sampleNames(List<String> sampleNames)

addSampleNamesItem

public BrAPICallSetsSearchRequest addSampleNamesItem(String sampleNamesItem)

getSampleNames

public List<String> getSampleNames()

Return only call sets generated from the provided Biosample human readable names.

Returns:

sampleNames

setSampleNames

public void setSampleNames(List<String> sampleNames)

studyDbIds

public BrAPICallSetsSearchRequest studyDbIds(List<String> studyDbIds)

addStudyDbIdsItem

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

addStudyNamesItem

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

addTrialDbIdsItem

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

addTrialNamesItem

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

variantSetDbIds

public BrAPICallSetsSearchRequest variantSetDbIds(List<String> variantSetDbIds)

addVariantSetDbIdsItem

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