org.brapi.v2.model.core.request

Class BrAPILocationSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.core.request.BrAPILocationSearchRequest

public class BrAPILocationSearchRequest
extends BrAPISearchRequestParametersPaging

BrAPILocationSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPILocationSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPILocationSearchRequest	abbreviations(List<String> abbreviations)
BrAPILocationSearchRequest	addAbbreviationsItem(String abbreviationsItem)
BrAPILocationSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPILocationSearchRequest	addCountryCodesItem(String countryCodesItem)
BrAPILocationSearchRequest	addCountryNamesItem(String countryNamesItem)
BrAPILocationSearchRequest	addExternalReferenceIdsItem(String externalReferenceIdsItem)
BrAPILocationSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem) Deprecated.
BrAPILocationSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPILocationSearchRequest	addInstituteAddressesItem(String instituteAddressesItem)
BrAPILocationSearchRequest	addInstituteNamesItem(String instituteNamesItem)
BrAPILocationSearchRequest	addLocationDbIdsItem(String locationDbIdsItem)
BrAPILocationSearchRequest	addLocationNamesItem(String locationNamesItem)
BrAPILocationSearchRequest	addLocationTypesItem(String locationTypesItem)
BrAPILocationSearchRequest	addParentLocationDbIdsItem(String parentLocationDbIdsItem)
BrAPILocationSearchRequest	addParentLocationNamesItem(String parentLocationNamesItem)
BrAPILocationSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPILocationSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPILocationSearchRequest	altitudeMax(BigDecimal altitudeMax)
BrAPILocationSearchRequest	altitudeMin(BigDecimal altitudeMin)
BrAPILocationSearchRequest	commonCropNames(List<String> commonCropNames)
BrAPILocationSearchRequest	coordinates(BrApiGeoJSON coordinates)
BrAPILocationSearchRequest	countryCodes(List<String> countryCodes)
BrAPILocationSearchRequest	countryNames(List<String> countryNames)
boolean	equals(Object o)
BrAPILocationSearchRequest	externalReferenceIds(List<String> externalReferenceIds)
BrAPILocationSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs)
BrAPILocationSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
List<String>	getAbbreviations() A list of shortened human readable names for a set of Locations
BigDecimal	getAltitudeMax() The maximum altitude to search for
BigDecimal	getAltitudeMin() The minimum altitude to search for
List<String>	getCommonCropNames() The BrAPI Common Crop Name is the simple, generalized, widely accepted name of the organism being researched.
BrApiGeoJSON	getCoordinates() Get coordinates
List<String>	getCountryCodes() [ISO_3166-1_alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) spec
List<String>	getCountryNames() The full name of the country to search for
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>	getInstituteAddresses() The street address of the institute to search for
List<String>	getInstituteNames() The name of the institute to search for
List<String>	getLocationDbIds() The location ids to search for
List<String>	getLocationNames() A human readable names to search for
List<String>	getLocationTypes() The type of location this represents (ex.
List<String>	getParentLocationDbIds() The unique identifier for a Location <br/> The Parent Location defines the encompassing location that this location belongs to.
List<String>	getParentLocationNames() A human readable name for a location <br/> The Parent Location defines the encompassing location that this location belongs to.
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.
int	hashCode()
BrAPILocationSearchRequest	instituteAddresses(List<String> instituteAddresses)
BrAPILocationSearchRequest	instituteNames(List<String> instituteNames)
BrAPILocationSearchRequest	locationDbIds(List<String> locationDbIds)
BrAPILocationSearchRequest	locationNames(List<String> locationNames)
BrAPILocationSearchRequest	locationTypes(List<String> locationTypes)
BrAPILocationSearchRequest	parentLocationDbIds(List<String> parentLocationDbIds)
BrAPILocationSearchRequest	parentLocationNames(List<String> parentLocationNames)
BrAPILocationSearchRequest	programDbIds(List<String> programDbIds)
BrAPILocationSearchRequest	programNames(List<String> programNames)
void	setAbbreviations(List<String> abbreviations)
void	setAltitudeMax(BigDecimal altitudeMax)
void	setAltitudeMin(BigDecimal altitudeMin)
void	setCommonCropNames(List<String> commonCropNames)
void	setCoordinates(BrApiGeoJSON coordinates)
void	setCountryCodes(List<String> countryCodes)
void	setCountryNames(List<String> countryNames)
void	setExternalReferenceIds(List<String> externalReferenceIds)
void	setExternalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
void	setExternalReferenceSources(List<String> externalReferenceSources)
void	setInstituteAddresses(List<String> instituteAddresses)
void	setInstituteNames(List<String> instituteNames)
void	setLocationDbIds(List<String> locationDbIds)
void	setLocationNames(List<String> locationNames)
void	setLocationTypes(List<String> locationTypes)
void	setParentLocationDbIds(List<String> parentLocationDbIds)
void	setParentLocationNames(List<String> parentLocationNames)
void	setProgramDbIds(List<String> programDbIds)
void	setProgramNames(List<String> programNames)
String	toString()

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

BrAPILocationSearchRequest

public BrAPILocationSearchRequest()

Method Detail

abbreviations

public BrAPILocationSearchRequest abbreviations(List<String> abbreviations)

addAbbreviationsItem

public BrAPILocationSearchRequest addAbbreviationsItem(String abbreviationsItem)

getAbbreviations

public List<String> getAbbreviations()

A list of shortened human readable names for a set of Locations

Returns:

abbreviations

setAbbreviations

public void setAbbreviations(List<String> abbreviations)

altitudeMax

public BrAPILocationSearchRequest altitudeMax(BigDecimal altitudeMax)

getAltitudeMax

public BigDecimal getAltitudeMax()

The maximum altitude to search for

Returns:

altitudeMax

setAltitudeMax

public void setAltitudeMax(BigDecimal altitudeMax)

altitudeMin

public BrAPILocationSearchRequest altitudeMin(BigDecimal altitudeMin)

getAltitudeMin

public BigDecimal getAltitudeMin()

The minimum altitude to search for

Returns:

altitudeMin

setAltitudeMin

public void setAltitudeMin(BigDecimal altitudeMin)

commonCropNames

public BrAPILocationSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

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

coordinates

public BrAPILocationSearchRequest coordinates(BrApiGeoJSON coordinates)

getCoordinates

public BrApiGeoJSON getCoordinates()

Get coordinates

Returns:

coordinates

setCoordinates

public void setCoordinates(BrApiGeoJSON coordinates)

countryCodes

public BrAPILocationSearchRequest countryCodes(List<String> countryCodes)

addCountryCodesItem

public BrAPILocationSearchRequest addCountryCodesItem(String countryCodesItem)

getCountryCodes

public List<String> getCountryCodes()

[ISO_3166-1_alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) spec

Returns:

countryCodes

setCountryCodes

public void setCountryCodes(List<String> countryCodes)

countryNames

public BrAPILocationSearchRequest countryNames(List<String> countryNames)

addCountryNamesItem

public BrAPILocationSearchRequest addCountryNamesItem(String countryNamesItem)

getCountryNames

public List<String> getCountryNames()

The full name of the country to search for

Returns:

countryNames

setCountryNames

public void setCountryNames(List<String> countryNames)

externalReferenceIDs

public BrAPILocationSearchRequest externalReferenceIDs(List<String> externalReferenceIDs)

addExternalReferenceIDsItem

@Deprecated
public BrAPILocationSearchRequest 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 BrAPILocationSearchRequest externalReferenceIds(List<String> externalReferenceIds)

addExternalReferenceIdsItem

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

addExternalReferenceSourcesItem

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

instituteAddresses

public BrAPILocationSearchRequest instituteAddresses(List<String> instituteAddresses)

addInstituteAddressesItem

public BrAPILocationSearchRequest addInstituteAddressesItem(String instituteAddressesItem)

getInstituteAddresses

public List<String> getInstituteAddresses()

The street address of the institute to search for

Returns:

instituteAddresses

setInstituteAddresses

public void setInstituteAddresses(List<String> instituteAddresses)

instituteNames

public BrAPILocationSearchRequest instituteNames(List<String> instituteNames)

addInstituteNamesItem

public BrAPILocationSearchRequest addInstituteNamesItem(String instituteNamesItem)

getInstituteNames

public List<String> getInstituteNames()

The name of the institute to search for

Returns:

instituteNames

setInstituteNames

public void setInstituteNames(List<String> instituteNames)

locationDbIds

public BrAPILocationSearchRequest locationDbIds(List<String> locationDbIds)

addLocationDbIdsItem

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

addLocationNamesItem

public BrAPILocationSearchRequest addLocationNamesItem(String locationNamesItem)

getLocationNames

public List<String> getLocationNames()

A human readable names to search for

Returns:

locationNames

setLocationNames

public void setLocationNames(List<String> locationNames)

locationTypes

public BrAPILocationSearchRequest locationTypes(List<String> locationTypes)

addLocationTypesItem

public BrAPILocationSearchRequest addLocationTypesItem(String locationTypesItem)

getLocationTypes

public List<String> getLocationTypes()

The type of location this represents (ex. Breeding Location, Storage Location, etc)

Returns:

locationTypes

setLocationTypes

public void setLocationTypes(List<String> locationTypes)

parentLocationDbIds

public BrAPILocationSearchRequest parentLocationDbIds(List<String> parentLocationDbIds)

addParentLocationDbIdsItem

public BrAPILocationSearchRequest addParentLocationDbIdsItem(String parentLocationDbIdsItem)

getParentLocationDbIds

public List<String> getParentLocationDbIds()

The unique identifier for a Location <br/> The Parent Location defines the encompassing location that this location belongs to. For example, an Institution might have multiple Field Stations inside it and each Field Station might have multiple Fields.

Returns:

parentLocationDbIds

setParentLocationDbIds

public void setParentLocationDbIds(List<String> parentLocationDbIds)

parentLocationNames

public BrAPILocationSearchRequest parentLocationNames(List<String> parentLocationNames)

addParentLocationNamesItem

public BrAPILocationSearchRequest addParentLocationNamesItem(String parentLocationNamesItem)

getParentLocationNames

public List<String> getParentLocationNames()

A human readable name for a location <br/> The Parent Location defines the encompassing location that this location belongs to. For example, an Institution might have multiple Field Stations inside it and each Field Station might have multiple Fields.

Returns:

parentLocationNames

setParentLocationNames

public void setParentLocationNames(List<String> parentLocationNames)

programDbIds

public BrAPILocationSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

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

addProgramNamesItem

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

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