org.brapi.v2.model.pheno.request

Class BrAPIObservationSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.pheno.request.BrAPIObservationSearchRequest

public class BrAPIObservationSearchRequest
extends BrAPISearchRequestParametersPaging

ObservationSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPIObservationSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPIObservationSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPIObservationSearchRequest	addExternalReferenceIdsItem(String externalReferenceIdsItem)
BrAPIObservationSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem) Deprecated.
BrAPIObservationSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPIObservationSearchRequest	addGermplasmDbIdsItem(String germplasmDbIdsItem)
BrAPIObservationSearchRequest	addGermplasmNamesItem(String germplasmNamesItem)
BrAPIObservationSearchRequest	addLocationDbIdsItem(String locationDbIdsItem)
BrAPIObservationSearchRequest	addLocationNamesItem(String locationNamesItem)
BrAPIObservationSearchRequest	addObservationDbIdsItem(String observationDbIdsItem)
BrAPIObservationSearchRequest	addObservationLevelRelationshipsItem(BrAPIObservationUnitLevelRelationship observationLevelRelationshipsItem)
BrAPIObservationSearchRequest	addObservationLevelsItem(BrAPIObservationUnitLevelRelationship observationLevelsItem)
BrAPIObservationSearchRequest	addObservationUnitDbIdsItem(String observationUnitDbIdsItem)
BrAPIObservationSearchRequest	addObservationVariableDbIdsItem(String observationVariableDbIdsItem)
BrAPIObservationSearchRequest	addObservationVariableNamesItem(String observationVariableNamesItem)
BrAPIObservationSearchRequest	addObservationVariablePUIsItem(String observationVariablePUIsItem)
BrAPIObservationSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPIObservationSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPIObservationSearchRequest	addSeasonDbIdsItem(String seasonDbIdsItem)
BrAPIObservationSearchRequest	addStudyDbIdsItem(String studyDbIdsItem)
BrAPIObservationSearchRequest	addStudyNamesItem(String studyNamesItem)
BrAPIObservationSearchRequest	addTrialDbIdsItem(String trialDbIdsItem)
BrAPIObservationSearchRequest	addTrialNamesItem(String trialNamesItem)
BrAPIObservationSearchRequest	commonCropNames(List<String> commonCropNames)
boolean	equals(Object o)
BrAPIObservationSearchRequest	externalReferenceIds(List<String> externalReferenceIds)
BrAPIObservationSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
BrAPIObservationSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
BrAPIObservationSearchRequest	germplasmDbIds(List<String> germplasmDbIds)
BrAPIObservationSearchRequest	germplasmNames(List<String> germplasmNames)
List<String>	getCommonCropNames() A program identifier to search 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>	getObservationDbIds() The unique id of an Observation
List<BrAPIObservationUnitLevelRelationship>	getObservationLevelRelationships() Searches for values in ObservationUnit->observationUnitPosition->observationLevelRelationships
List<BrAPIObservationUnitLevelRelationship>	getObservationLevels() Searches for values in ObservationUnit->observationUnitPosition->observationLevel
OffsetDateTime	getObservationTimeStampRangeEnd() Timestamp range end
OffsetDateTime	getObservationTimeStampRangeStart() Timestamp range start
List<String>	getObservationUnitDbIds() The unique id of an Observation Unit
List<String>	getObservationVariableDbIds() The DbIds of Variables 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 year or Phenotyping campaign of a multi-annual study (trees, grape, ...)
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()
BrAPIObservationSearchRequest	locationDbIds(List<String> locationDbIds)
BrAPIObservationSearchRequest	locationNames(List<String> locationNames)
BrAPIObservationSearchRequest	observationDbIds(List<String> observationDbIds)
BrAPIObservationSearchRequest	observationLevelRelationships(List<BrAPIObservationUnitLevelRelationship> observationLevelRelationships)
BrAPIObservationSearchRequest	observationLevels(List<BrAPIObservationUnitLevelRelationship> observationLevels)
BrAPIObservationSearchRequest	observationTimeStampRangeEnd(OffsetDateTime observationTimeStampRangeEnd)
BrAPIObservationSearchRequest	observationTimeStampRangeStart(OffsetDateTime observationTimeStampRangeStart)
BrAPIObservationSearchRequest	observationUnitDbIds(List<String> observationUnitDbIds)
BrAPIObservationSearchRequest	observationVariableDbIds(List<String> observationVariableDbIds)
BrAPIObservationSearchRequest	observationVariableNames(List<String> observationVariableNames)
BrAPIObservationSearchRequest	observationVariablePUIs(List<String> observationVariablePUIs)
BrAPIObservationSearchRequest	programDbIds(List<String> programDbIds)
BrAPIObservationSearchRequest	programNames(List<String> programNames)
BrAPIObservationSearchRequest	seasonDbIds(List<String> seasonDbIds)
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	setObservationDbIds(List<String> observationDbIds)
void	setObservationLevelRelationships(List<BrAPIObservationUnitLevelRelationship> observationLevelRelationships)
void	setObservationLevels(List<BrAPIObservationUnitLevelRelationship> observationLevels)
void	setObservationTimeStampRangeEnd(OffsetDateTime observationTimeStampRangeEnd)
void	setObservationTimeStampRangeStart(OffsetDateTime observationTimeStampRangeStart)
void	setObservationUnitDbIds(List<String> observationUnitDbIds)
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	setStudyDbIds(List<String> studyDbIds)
void	setStudyNames(List<String> studyNames)
void	setTrialDbIds(List<String> trialDbIds)
void	setTrialNames(List<String> trialNames)
BrAPIObservationSearchRequest	studyDbIds(List<String> studyDbIds)
BrAPIObservationSearchRequest	studyNames(List<String> studyNames)
String	toString()
BrAPIObservationSearchRequest	trialDbIds(List<String> trialDbIds)
BrAPIObservationSearchRequest	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

BrAPIObservationSearchRequest

public BrAPIObservationSearchRequest()

Method Detail

commonCropNames

public BrAPIObservationSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

public BrAPIObservationSearchRequest addCommonCropNamesItem(String commonCropNamesItem)

getCommonCropNames

public List<String> getCommonCropNames()

A program identifier to search for

Returns:

commonCropNames

setCommonCropNames

public void setCommonCropNames(List<String> commonCropNames)

programDbIds

public BrAPIObservationSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

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

addProgramNamesItem

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

addTrialDbIdsItem

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

addTrialNamesItem

public BrAPIObservationSearchRequest 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 BrAPIObservationSearchRequest studyDbIds(List<String> studyDbIds)

addStudyDbIdsItem

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

addStudyNamesItem

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

germplasmDbIds

public BrAPIObservationSearchRequest germplasmDbIds(List<String> germplasmDbIds)

addGermplasmDbIdsItem

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

addGermplasmNamesItem

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

locationDbIds

public BrAPIObservationSearchRequest locationDbIds(List<String> locationDbIds)

addLocationDbIdsItem

public BrAPIObservationSearchRequest 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 BrAPIObservationSearchRequest locationNames(List<String> locationNames)

addLocationNamesItem

public BrAPIObservationSearchRequest addLocationNamesItem(String locationNamesItem)

getLocationNames

public List<String> getLocationNames()

A human readable names to search for

Returns:

locationNames

setLocationNames

public void setLocationNames(List<String> locationNames)

observationVariableDbIds

public BrAPIObservationSearchRequest observationVariableDbIds(List<String> observationVariableDbIds)

addObservationVariableDbIdsItem

public BrAPIObservationSearchRequest addObservationVariableDbIdsItem(String observationVariableDbIdsItem)

getObservationVariableDbIds

public List<String> getObservationVariableDbIds()

The DbIds of Variables to search for

Returns:

observationVariableDbIds

setObservationVariableDbIds

public void setObservationVariableDbIds(List<String> observationVariableDbIds)

observationVariableNames

public BrAPIObservationSearchRequest observationVariableNames(List<String> observationVariableNames)

addObservationVariableNamesItem

public BrAPIObservationSearchRequest addObservationVariableNamesItem(String observationVariableNamesItem)

getObservationVariableNames

public List<String> getObservationVariableNames()

The names of Variables to search for

Returns:

observationVariableNames

setObservationVariableNames

public void setObservationVariableNames(List<String> observationVariableNames)

observationVariablePUIs

public BrAPIObservationSearchRequest observationVariablePUIs(List<String> observationVariablePUIs)

addObservationVariablePUIsItem

public BrAPIObservationSearchRequest addObservationVariablePUIsItem(String observationVariablePUIsItem)

getObservationVariablePUIs

public List<String> getObservationVariablePUIs()

The names of Variables to search for

Returns:

observationVariablePUIs

setObservationVariablePUIs

public void setObservationVariablePUIs(List<String> observationVariablePUIs)

externalReferenceIds

public BrAPIObservationSearchRequest externalReferenceIds(List<String> externalReferenceIds)

addExternalReferenceIdsItem

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

Deprecated.

addExternalReferenceIDsItem

@Deprecated
public BrAPIObservationSearchRequest 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 BrAPIObservationSearchRequest externalReferenceSources(List<String> externalReferenceSources)

addExternalReferenceSourcesItem

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

observationDbIds

public BrAPIObservationSearchRequest observationDbIds(List<String> observationDbIds)

addObservationDbIdsItem

public BrAPIObservationSearchRequest addObservationDbIdsItem(String observationDbIdsItem)

getObservationDbIds

public List<String> getObservationDbIds()

The unique id of an Observation

Returns:

observationDbIds

setObservationDbIds

public void setObservationDbIds(List<String> observationDbIds)

observationLevelRelationships

public BrAPIObservationSearchRequest observationLevelRelationships(List<BrAPIObservationUnitLevelRelationship> observationLevelRelationships)

addObservationLevelRelationshipsItem

public BrAPIObservationSearchRequest addObservationLevelRelationshipsItem(BrAPIObservationUnitLevelRelationship observationLevelRelationshipsItem)

getObservationLevelRelationships

public List<BrAPIObservationUnitLevelRelationship> getObservationLevelRelationships()

Searches for values in ObservationUnit->observationUnitPosition->observationLevelRelationships

Returns:

observationLevelRelationships

setObservationLevelRelationships

public void setObservationLevelRelationships(List<BrAPIObservationUnitLevelRelationship> observationLevelRelationships)

observationLevels

public BrAPIObservationSearchRequest observationLevels(List<BrAPIObservationUnitLevelRelationship> observationLevels)

addObservationLevelsItem

public BrAPIObservationSearchRequest addObservationLevelsItem(BrAPIObservationUnitLevelRelationship observationLevelsItem)

getObservationLevels

public List<BrAPIObservationUnitLevelRelationship> getObservationLevels()

Searches for values in ObservationUnit->observationUnitPosition->observationLevel

Returns:

observationLevels

setObservationLevels

public void setObservationLevels(List<BrAPIObservationUnitLevelRelationship> observationLevels)

observationTimeStampRangeEnd

public BrAPIObservationSearchRequest observationTimeStampRangeEnd(OffsetDateTime observationTimeStampRangeEnd)

getObservationTimeStampRangeEnd

public OffsetDateTime getObservationTimeStampRangeEnd()

Timestamp range end

Returns:

observationTimeStampRangeEnd

setObservationTimeStampRangeEnd

public void setObservationTimeStampRangeEnd(OffsetDateTime observationTimeStampRangeEnd)

observationTimeStampRangeStart

public BrAPIObservationSearchRequest observationTimeStampRangeStart(OffsetDateTime observationTimeStampRangeStart)

getObservationTimeStampRangeStart

public OffsetDateTime getObservationTimeStampRangeStart()

Timestamp range start

Returns:

observationTimeStampRangeStart

setObservationTimeStampRangeStart

public void setObservationTimeStampRangeStart(OffsetDateTime observationTimeStampRangeStart)

observationUnitDbIds

public BrAPIObservationSearchRequest observationUnitDbIds(List<String> observationUnitDbIds)

addObservationUnitDbIdsItem

public BrAPIObservationSearchRequest addObservationUnitDbIdsItem(String observationUnitDbIdsItem)

getObservationUnitDbIds

public List<String> getObservationUnitDbIds()

The unique id of an Observation Unit

Returns:

observationUnitDbIds

setObservationUnitDbIds

public void setObservationUnitDbIds(List<String> observationUnitDbIds)

seasonDbIds

public BrAPIObservationSearchRequest seasonDbIds(List<String> seasonDbIds)

addSeasonDbIdsItem

public BrAPIObservationSearchRequest addSeasonDbIdsItem(String seasonDbIdsItem)

getSeasonDbIds

public List<String> getSeasonDbIds()

The year or Phenotyping campaign of a multi-annual study (trees, grape, ...)

Returns:

seasonDbIds

setSeasonDbIds

public void setSeasonDbIds(List<String> seasonDbIds)

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