org.brapi.v2.model.core.request

Class BrAPIStudySearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.core.request.BrAPIStudySearchRequest

public class BrAPIStudySearchRequest
extends BrAPISearchRequestParametersPaging

StudySearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPIStudySearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPIStudySearchRequest	active(Boolean active)
BrAPIStudySearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPIStudySearchRequest	addExternalReferenceIdsItem(String externalReferenceIdsItem)
BrAPIStudySearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem) Deprecated.
BrAPIStudySearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPIStudySearchRequest	addGermplasmDbIdsItem(String germplasmDbIdsItem)
BrAPIStudySearchRequest	addGermplasmNamesItem(String germplasmNamesItem)
BrAPIStudySearchRequest	addLocationDbIdsItem(String locationDbIdsItem)
BrAPIStudySearchRequest	addLocationNamesItem(String locationNamesItem)
BrAPIStudySearchRequest	addObservationVariableDbIdsItem(String observationVariableDbIdsItem)
BrAPIStudySearchRequest	addObservationVariableNamesItem(String observationVariableNamesItem)
BrAPIStudySearchRequest	addObservationVariablePUIsItem(String observationVariablePUIsItem)
BrAPIStudySearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPIStudySearchRequest	addProgramNamesItem(String programNamesItem)
BrAPIStudySearchRequest	addSeasonDbIdsItem(String seasonDbIdsItem)
BrAPIStudySearchRequest	addStudyCodesItem(String studyCodesItem)
BrAPIStudySearchRequest	addStudyDbIdsItem(String studyDbIdsItem)
BrAPIStudySearchRequest	addStudyNamesItem(String studyNamesItem)
BrAPIStudySearchRequest	addStudyPUIsItem(String studyPUIsItem)
BrAPIStudySearchRequest	addStudyTypesItem(String studyTypesItem)
BrAPIStudySearchRequest	addTrialDbIdsItem(String trialDbIdsItem)
BrAPIStudySearchRequest	addTrialNamesItem(String trialNamesItem)
BrAPIStudySearchRequest	commonCropNames(List<String> commonCropNames)
boolean	equals(Object o)
BrAPIStudySearchRequest	externalReferenceIds(List<String> externalReferenceIds)
BrAPIStudySearchRequest	externalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
BrAPIStudySearchRequest	externalReferenceSources(List<String> externalReferenceSources)
BrAPIStudySearchRequest	germplasmDbIds(List<String> germplasmDbIds)
BrAPIStudySearchRequest	germplasmNames(List<String> germplasmNames)
List<String>	getCommonCropNames() Common name for the crop which this program is for
List<String>	getExternalReferenceIds() List of external references for the trait to search for
List<String>	getExternalReferenceIDs() Deprecated.
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>	getLocationDbIds() The location ids to search for
List<String>	getLocationNames() A human readable names to search for
List<String>	getObservationVariableDbIds() List of observation variable IDs to search for
List<String>	getObservationVariableNames() The names of Variables to search for
List<String>	getObservationVariablePUIs() The names of Variables to search for
List<String>	getProgramDbIds() A program identifier to search for
List<String>	getProgramNames() A name of a program to search for
List<String>	getSeasonDbIds() The ID which uniquely identifies a season
BrAPISortBy	getSortBy() Name of one of the fields within the study object on which results can be sorted
BrAPISortOrder	getSortOrder() Order results should be sorted.
List<String>	getStudyCodes() A short human readable code for a study
List<String>	getStudyDbIds() List of study identifiers to search for
List<String>	getStudyNames() List of study names to filter search results
List<String>	getStudyPUIs() Permanent unique identifier associated with study data.
List<String>	getStudyTypes() The type of study being performed.
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()
Boolean	isActive() Is this study currently active
BrAPIStudySearchRequest	locationDbIds(List<String> locationDbIds)
BrAPIStudySearchRequest	locationNames(List<String> locationNames)
BrAPIStudySearchRequest	observationVariableDbIds(List<String> observationVariableDbIds)
BrAPIStudySearchRequest	observationVariableNames(List<String> observationVariableNames)
BrAPIStudySearchRequest	observationVariablePUIs(List<String> observationVariablePUIs)
BrAPIStudySearchRequest	programDbIds(List<String> programDbIds)
BrAPIStudySearchRequest	programNames(List<String> programNames)
BrAPIStudySearchRequest	seasonDbIds(List<String> seasonDbIds)
void	setActive(Boolean active)
void	setCommonCropNames(List<String> commonCropNames)
void	setExternalReferenceIds(List<String> externalReferenceIds)
void	setExternalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
void	setExternalReferenceSources(List<String> externalReferenceSources)
void	setGermplasmDbIds(List<String> germplasmDbIds)
void	setGermplasmNames(List<String> germplasmNames)
void	setLocationDbIds(List<String> locationDbIds)
void	setLocationNames(List<String> locationNames)
void	setObservationVariableDbIds(List<String> observationVariableDbIds)
void	setObservationVariableNames(List<String> observationVariableNames)
void	setObservationVariablePUIs(List<String> observationVariablePUIs)
void	setProgramDbIds(List<String> programDbIds)
void	setProgramNames(List<String> programNames)
void	setSeasonDbIds(List<String> seasonDbIds)
void	setSortBy(BrAPISortBy sortBy)
void	setSortOrder(BrAPISortOrder sortOrder)
void	setStudyCodes(List<String> studyCodes)
void	setStudyDbIds(List<String> studyDbIds)
void	setStudyNames(List<String> studyNames)
void	setStudyPUIs(List<String> studyPUIs)
void	setStudyTypes(List<String> studyTypes)
void	setTrialDbIds(List<String> trialDbIds)
void	setTrialNames(List<String> trialNames)
BrAPIStudySearchRequest	sortBy(BrAPISortBy sortBy)
BrAPIStudySearchRequest	sortOrder(BrAPISortOrder sortOrder)
BrAPIStudySearchRequest	studyCodes(List<String> studyCodes)
BrAPIStudySearchRequest	studyDbIds(List<String> studyDbIds)
BrAPIStudySearchRequest	studyNames(List<String> studyNames)
BrAPIStudySearchRequest	studyPUIs(List<String> studyPUIs)
BrAPIStudySearchRequest	studyTypes(List<String> studyTypes)
String	toString()
BrAPIStudySearchRequest	trialDbIds(List<String> trialDbIds)
BrAPIStudySearchRequest	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

BrAPIStudySearchRequest

public BrAPIStudySearchRequest()

Method Detail

commonCropNames

public BrAPIStudySearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

public BrAPIStudySearchRequest addCommonCropNamesItem(String commonCropNamesItem)

getCommonCropNames

public List<String> getCommonCropNames()

Common name for the crop which this program is for

Returns:

commonCropNames

setCommonCropNames

public void setCommonCropNames(List<String> commonCropNames)

programDbIds

public BrAPIStudySearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

public BrAPIStudySearchRequest addProgramDbIdsItem(String programDbIdsItem)

getProgramDbIds

public List<String> getProgramDbIds()

A program identifier to search for

Returns:

programDbIds

setProgramDbIds

public void setProgramDbIds(List<String> programDbIds)

programNames

public BrAPIStudySearchRequest programNames(List<String> programNames)

addProgramNamesItem

public BrAPIStudySearchRequest addProgramNamesItem(String programNamesItem)

getProgramNames

public List<String> getProgramNames()

A name of a program to search for

Returns:

programNames

setProgramNames

public void setProgramNames(List<String> programNames)

trialDbIds

public BrAPIStudySearchRequest trialDbIds(List<String> trialDbIds)

addTrialDbIdsItem

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

addTrialNamesItem

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

studyDbIds

public BrAPIStudySearchRequest studyDbIds(List<String> studyDbIds)

addStudyDbIdsItem

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

addStudyNamesItem

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

locationDbIds

public BrAPIStudySearchRequest locationDbIds(List<String> locationDbIds)

addLocationDbIdsItem

public BrAPIStudySearchRequest addLocationDbIdsItem(String locationDbIdsItem)

getLocationDbIds

public List<String> getLocationDbIds()

The location ids to search for

Returns:

locationDbIds

setLocationDbIds

public void setLocationDbIds(List<String> locationDbIds)

locationNames

public BrAPIStudySearchRequest locationNames(List<String> locationNames)

addLocationNamesItem

public BrAPIStudySearchRequest addLocationNamesItem(String locationNamesItem)

getLocationNames

public List<String> getLocationNames()

A human readable names to search for

Returns:

locationNames

setLocationNames

public void setLocationNames(List<String> locationNames)

germplasmDbIds

public BrAPIStudySearchRequest germplasmDbIds(List<String> germplasmDbIds)

addGermplasmDbIdsItem

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

addGermplasmNamesItem

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

observationVariableDbIds

public BrAPIStudySearchRequest observationVariableDbIds(List<String> observationVariableDbIds)

addObservationVariableDbIdsItem

public BrAPIStudySearchRequest addObservationVariableDbIdsItem(String observationVariableDbIdsItem)

getObservationVariableDbIds

public List<String> getObservationVariableDbIds()

List of observation variable IDs to search for

Returns:

observationVariableDbIds

setObservationVariableDbIds

public void setObservationVariableDbIds(List<String> observationVariableDbIds)

observationVariablePUIs

public BrAPIStudySearchRequest observationVariablePUIs(List<String> observationVariablePUIs)

addObservationVariablePUIsItem

public BrAPIStudySearchRequest addObservationVariablePUIsItem(String observationVariablePUIsItem)

getObservationVariablePUIs

public List<String> getObservationVariablePUIs()

The names of Variables to search for

Returns:

observationVariablePUIs

setObservationVariablePUIs

public void setObservationVariablePUIs(List<String> observationVariablePUIs)

observationVariableNames

public BrAPIStudySearchRequest observationVariableNames(List<String> observationVariableNames)

addObservationVariableNamesItem

public BrAPIStudySearchRequest addObservationVariableNamesItem(String observationVariableNamesItem)

getObservationVariableNames

public List<String> getObservationVariableNames()

The names of Variables to search for

Returns:

observationVariableNames

setObservationVariableNames

public void setObservationVariableNames(List<String> observationVariableNames)

externalReferenceIds

public BrAPIStudySearchRequest externalReferenceIds(List<String> externalReferenceIds)

addExternalReferenceIdsItem

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

externalReferenceIDs

@Deprecated
public BrAPIStudySearchRequest externalReferenceIDs(List<String> externalReferenceIDs)

Deprecated.

addExternalReferenceIDsItem

@Deprecated
public BrAPIStudySearchRequest addExternalReferenceIDsItem(String externalReferenceIDsItem)

Deprecated.

getExternalReferenceIDs

@Deprecated
public List<String> getExternalReferenceIDs()

Deprecated.

List of external references for the trait to search for

Returns:

externalReferenceIDs

setExternalReferenceIDs

@Deprecated
public void setExternalReferenceIDs(List<String> externalReferenceIDs)

Deprecated.

externalReferenceSources

public BrAPIStudySearchRequest externalReferenceSources(List<String> externalReferenceSources)

addExternalReferenceSourcesItem

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

active

public BrAPIStudySearchRequest active(Boolean active)

isActive

public Boolean isActive()

Is this study currently active

Returns:

active

setActive

public void setActive(Boolean active)

seasonDbIds

public BrAPIStudySearchRequest seasonDbIds(List<String> seasonDbIds)

addSeasonDbIdsItem

public BrAPIStudySearchRequest addSeasonDbIdsItem(String seasonDbIdsItem)

getSeasonDbIds

public List<String> getSeasonDbIds()

The ID which uniquely identifies a season

Returns:

seasonDbIds

setSeasonDbIds

public void setSeasonDbIds(List<String> seasonDbIds)

sortBy

public BrAPIStudySearchRequest sortBy(BrAPISortBy sortBy)

getSortBy

public BrAPISortBy getSortBy()

Name of one of the fields within the study object on which results can be sorted

Returns:

sortBy

setSortBy

public void setSortBy(BrAPISortBy sortBy)

sortOrder

public BrAPIStudySearchRequest sortOrder(BrAPISortOrder sortOrder)

getSortOrder

public BrAPISortOrder getSortOrder()

Order results should be sorted. ex. \"ASC\" or \"DESC\"

Returns:

sortOrder

setSortOrder

public void setSortOrder(BrAPISortOrder sortOrder)

studyCodes

public BrAPIStudySearchRequest studyCodes(List<String> studyCodes)

addStudyCodesItem

public BrAPIStudySearchRequest addStudyCodesItem(String studyCodesItem)

getStudyCodes

public List<String> getStudyCodes()

A short human readable code for a study

Returns:

studyCodes

setStudyCodes

public void setStudyCodes(List<String> studyCodes)

studyPUIs

public BrAPIStudySearchRequest studyPUIs(List<String> studyPUIs)

addStudyPUIsItem

public BrAPIStudySearchRequest addStudyPUIsItem(String studyPUIsItem)

getStudyPUIs

public List<String> getStudyPUIs()

Permanent unique identifier associated with study data. For example, a URI or DOI

Returns:

studyPUIs

setStudyPUIs

public void setStudyPUIs(List<String> studyPUIs)

studyTypes

public BrAPIStudySearchRequest studyTypes(List<String> studyTypes)

addStudyTypesItem

public BrAPIStudySearchRequest addStudyTypesItem(String studyTypesItem)

getStudyTypes

public List<String> getStudyTypes()

The type of study being performed. ex. \"Yield Trial\", etc

Returns:

studyTypes

setStudyTypes

public void setStudyTypes(List<String> studyTypes)

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