org.brapi.v2.model.pheno.request

Class BrAPIObservationUnitSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.pheno.request.BrAPIObservationUnitSearchRequest

public class BrAPIObservationUnitSearchRequest
extends BrAPISearchRequestParametersPaging

BrAPIObservationUnitSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPIObservationUnitSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPIObservationUnitSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPIObservationUnitSearchRequest	addExternalReferenceIdsItem(String externalReferenceIdsItem)
BrAPIObservationUnitSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem) Deprecated.
BrAPIObservationUnitSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPIObservationUnitSearchRequest	addGermplasmDbIdsItem(String germplasmDbIdsItem)
BrAPIObservationUnitSearchRequest	addGermplasmNamesItem(String germplasmNamesItem)
BrAPIObservationUnitSearchRequest	addLocationDbIdsItem(String locationDbIdsItem)
BrAPIObservationUnitSearchRequest	addLocationNamesItem(String locationNamesItem)
BrAPIObservationUnitSearchRequest	addObservationLevelRelationshipsItem(BrAPIObservationUnitLevelRelationship observationLevelRelationshipsItem)
BrAPIObservationUnitSearchRequest	addObservationLevelsItem(BrAPIObservationUnitHierarchyLevel observationLevelsItem)
BrAPIObservationUnitSearchRequest	addObservationUnitDbIdsItem(String observationUnitDbIdsItem)
BrAPIObservationUnitSearchRequest	addObservationUnitNamesItem(String observationUnitNamesItem)
BrAPIObservationUnitSearchRequest	addObservationVariableDbIdsItem(String observationVariableDbIdsItem)
BrAPIObservationUnitSearchRequest	addObservationVariableNamesItem(String observationVariableNamesItem)
BrAPIObservationUnitSearchRequest	addObservationVariablePUIsItem(String observationVariablePUIsItem)
BrAPIObservationUnitSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPIObservationUnitSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPIObservationUnitSearchRequest	addSeasonDbIdsItem(String seasonDbIdsItem)
BrAPIObservationUnitSearchRequest	addStudyDbIdsItem(String studyDbIdsItem)
BrAPIObservationUnitSearchRequest	addStudyNamesItem(String studyNamesItem)
BrAPIObservationUnitSearchRequest	addTrialDbIdsItem(String trialDbIdsItem)
BrAPIObservationUnitSearchRequest	addTrialNamesItem(String trialNamesItem)
BrAPIObservationUnitSearchRequest	commonCropNames(List<String> commonCropNames)
boolean	equals(Object o)
BrAPIObservationUnitSearchRequest	externalReferenceIds(List<String> externalReferenceIds)
BrAPIObservationUnitSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
BrAPIObservationUnitSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
BrAPIObservationUnitSearchRequest	germplasmDbIds(List<String> germplasmDbIds)
BrAPIObservationUnitSearchRequest	germplasmNames(List<String> germplasmNames)
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.
List<String>	getExternalReferenceSources() List of identifiers for the source system or database of an external reference (use with `externalReferenceIDs` parameter)
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<BrAPIObservationUnitLevelRelationship>	getObservationLevelRelationships() Searches for values in ObservationUnit->observationUnitPosition->observationLevelRelationships
List<BrAPIObservationUnitHierarchyLevel>	getObservationLevels() Searches for values in ObservationUnit->observationUnitPosition->observationLevel
List<String>	getObservationUnitDbIds() The unique id of an observation unit
List<String>	getObservationUnitNames() The human readable identifier for 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 Permanent Unique Identifier of an Observation Variable, usually in the form of a URI
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>	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()
BrAPIObservationUnitSearchRequest	includeObservations(Boolean includeObservations)
Boolean	isIncludeObservations() Use this parameter to include a list of observations embedded in each ObservationUnit object.
BrAPIObservationUnitSearchRequest	locationDbIds(List<String> locationDbIds)
BrAPIObservationUnitSearchRequest	locationNames(List<String> locationNames)
BrAPIObservationUnitSearchRequest	observationLevelRelationships(List<BrAPIObservationUnitLevelRelationship> observationLevelRelationships)
BrAPIObservationUnitSearchRequest	observationLevels(List<BrAPIObservationUnitHierarchyLevel> observationLevels)
BrAPIObservationUnitSearchRequest	observationUnitDbIds(List<String> observationUnitDbIds)
BrAPIObservationUnitSearchRequest	observationUnitNames(List<String> observationUnitNames)
BrAPIObservationUnitSearchRequest	observationVariableDbIds(List<String> observationVariableDbIds)
BrAPIObservationUnitSearchRequest	observationVariableNames(List<String> observationVariableNames)
BrAPIObservationUnitSearchRequest	observationVariablePUIs(List<String> observationVariablePUIs)
BrAPIObservationUnitSearchRequest	programDbIds(List<String> programDbIds)
BrAPIObservationUnitSearchRequest	programNames(List<String> programNames)
BrAPIObservationUnitSearchRequest	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	setIncludeObservations(Boolean includeObservations)
void	setLocationDbIds(List<String> locationDbIds)
void	setLocationNames(List<String> locationNames)
void	setObservationLevelRelationships(List<BrAPIObservationUnitLevelRelationship> observationLevelRelationships)
void	setObservationLevels(List<BrAPIObservationUnitHierarchyLevel> observationLevels)
void	setObservationUnitDbIds(List<String> observationUnitDbIds)
void	setObservationUnitNames(List<String> observationUnitNames)
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)
BrAPIObservationUnitSearchRequest	studyDbIds(List<String> studyDbIds)
BrAPIObservationUnitSearchRequest	studyNames(List<String> studyNames)
String	toString()
BrAPIObservationUnitSearchRequest	trialDbIds(List<String> trialDbIds)
BrAPIObservationUnitSearchRequest	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

BrAPIObservationUnitSearchRequest

public BrAPIObservationUnitSearchRequest()

Method Detail

commonCropNames

public BrAPIObservationUnitSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

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

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

Deprecated.

addExternalReferenceIDsItem

@Deprecated
public BrAPIObservationUnitSearchRequest addExternalReferenceIDsItem(String externalReferenceIDsItem)

Deprecated.

getExternalReferenceIDs

@Deprecated
public List<String> getExternalReferenceIDs()

Deprecated.

**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

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

Deprecated.

externalReferenceIds

public BrAPIObservationUnitSearchRequest externalReferenceIds(List<String> externalReferenceIds)

addExternalReferenceIdsItem

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

addExternalReferenceSourcesItem

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

germplasmDbIds

public BrAPIObservationUnitSearchRequest germplasmDbIds(List<String> germplasmDbIds)

addGermplasmDbIdsItem

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

addGermplasmNamesItem

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

includeObservations

public BrAPIObservationUnitSearchRequest includeObservations(Boolean includeObservations)

isIncludeObservations

public Boolean isIncludeObservations()

Use this parameter to include a list of observations embedded in each ObservationUnit object. CAUTION - Use this parameter at your own risk. It may return large, unpaginated lists of observation data. Only set this value to True if you are sure you need to.

Returns:

includeObservations

setIncludeObservations

public void setIncludeObservations(Boolean includeObservations)

locationDbIds

public BrAPIObservationUnitSearchRequest locationDbIds(List<String> locationDbIds)

addLocationDbIdsItem

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

addLocationNamesItem

public BrAPIObservationUnitSearchRequest addLocationNamesItem(String locationNamesItem)

getLocationNames

public List<String> getLocationNames()

A human readable names to search for

Returns:

locationNames

setLocationNames

public void setLocationNames(List<String> locationNames)

observationLevelRelationships

public BrAPIObservationUnitSearchRequest observationLevelRelationships(List<BrAPIObservationUnitLevelRelationship> observationLevelRelationships)

addObservationLevelRelationshipsItem

public BrAPIObservationUnitSearchRequest 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 BrAPIObservationUnitSearchRequest observationLevels(List<BrAPIObservationUnitHierarchyLevel> observationLevels)

addObservationLevelsItem

public BrAPIObservationUnitSearchRequest addObservationLevelsItem(BrAPIObservationUnitHierarchyLevel observationLevelsItem)

getObservationLevels

public List<BrAPIObservationUnitHierarchyLevel> getObservationLevels()

Searches for values in ObservationUnit->observationUnitPosition->observationLevel

Returns:

observationLevels

setObservationLevels

public void setObservationLevels(List<BrAPIObservationUnitHierarchyLevel> observationLevels)

observationUnitDbIds

public BrAPIObservationUnitSearchRequest observationUnitDbIds(List<String> observationUnitDbIds)

addObservationUnitDbIdsItem

public BrAPIObservationUnitSearchRequest addObservationUnitDbIdsItem(String observationUnitDbIdsItem)

getObservationUnitDbIds

public List<String> getObservationUnitDbIds()

The unique id of an observation unit

Returns:

observationUnitDbIds

setObservationUnitDbIds

public void setObservationUnitDbIds(List<String> observationUnitDbIds)

observationUnitNames

public BrAPIObservationUnitSearchRequest observationUnitNames(List<String> observationUnitNames)

addObservationUnitNamesItem

public BrAPIObservationUnitSearchRequest addObservationUnitNamesItem(String observationUnitNamesItem)

getObservationUnitNames

public List<String> getObservationUnitNames()

The human readable identifier for an Observation Unit

Returns:

observationUnitNames

setObservationUnitNames

public void setObservationUnitNames(List<String> observationUnitNames)

observationVariableDbIds

public BrAPIObservationUnitSearchRequest observationVariableDbIds(List<String> observationVariableDbIds)

addObservationVariableDbIdsItem

public BrAPIObservationUnitSearchRequest 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 BrAPIObservationUnitSearchRequest observationVariableNames(List<String> observationVariableNames)

addObservationVariableNamesItem

public BrAPIObservationUnitSearchRequest 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 BrAPIObservationUnitSearchRequest observationVariablePUIs(List<String> observationVariablePUIs)

addObservationVariablePUIsItem

public BrAPIObservationUnitSearchRequest addObservationVariablePUIsItem(String observationVariablePUIsItem)

getObservationVariablePUIs

public List<String> getObservationVariablePUIs()

The Permanent Unique Identifier of an Observation Variable, usually in the form of a URI

Returns:

observationVariablePUIs

setObservationVariablePUIs

public void setObservationVariablePUIs(List<String> observationVariablePUIs)

programDbIds

public BrAPIObservationUnitSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

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

addProgramNamesItem

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

seasonDbIds

public BrAPIObservationUnitSearchRequest seasonDbIds(List<String> seasonDbIds)

addSeasonDbIdsItem

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

studyDbIds

public BrAPIObservationUnitSearchRequest studyDbIds(List<String> studyDbIds)

addStudyDbIdsItem

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

addStudyNamesItem

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

addTrialDbIdsItem

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

addTrialNamesItem

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