org.brapi.v2.model.core.request

Class BrAPIListSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.core.request.BrAPIListSearchRequest

public class BrAPIListSearchRequest
extends BrAPISearchRequestParametersPaging

ListSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPIListSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPIListSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPIListSearchRequest	addExternalReferenceIdsItem(String externalReferenceIdsItem)
BrAPIListSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem) Deprecated.
BrAPIListSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPIListSearchRequest	addListDbIdsItem(String listDbIdsItem)
BrAPIListSearchRequest	addListNamesItem(String listNamesItem)
BrAPIListSearchRequest	addListOwnerNamesItem(String listOwnerNamesItem)
BrAPIListSearchRequest	addListOwnerPersonDbIdsItem(String listOwnerPersonDbIdsItem)
BrAPIListSearchRequest	addListSourcesItem(String listSourcesItem)
BrAPIListSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPIListSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPIListSearchRequest	commonCropNames(List<String> commonCropNames)
BrAPIListSearchRequest	dateCreatedRangeEnd(OffsetDateTime dateCreatedRangeEnd)
BrAPIListSearchRequest	dateCreatedRangeStart(OffsetDateTime dateCreatedRangeStart)
BrAPIListSearchRequest	dateModifiedRangeEnd(OffsetDateTime dateModifiedRangeEnd)
BrAPIListSearchRequest	dateModifiedRangeStart(OffsetDateTime dateModifiedRangeStart)
boolean	equals(Object o)
BrAPIListSearchRequest	externalReferenceIds(List<String> externalReferenceIds)
BrAPIListSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
BrAPIListSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
List<String>	getCommonCropNames() The BrAPI Common Crop Name is the simple, generalized, widely accepted name of the organism being researched.
OffsetDateTime	getDateCreatedRangeEnd() Get dateCreatedRangeEnd
OffsetDateTime	getDateCreatedRangeStart() Get dateCreatedRangeStart
OffsetDateTime	getDateModifiedRangeEnd() Get dateModifiedRangeEnd
OffsetDateTime	getDateModifiedRangeStart() Get dateModifiedRangeStart
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>	getListDbIds() Get listDbIds
List<String>	getListNames() Get listNames
List<String>	getListOwnerNames() Get listOwnerNames
List<String>	getListOwnerPersonDbIds() Get listOwnerPersonDbIds
List<String>	getListSources() Get listSources
BrAPIListTypes	getListType() Get listType
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()
BrAPIListSearchRequest	listDbIds(List<String> listDbIds)
BrAPIListSearchRequest	listNames(List<String> listNames)
BrAPIListSearchRequest	listOwnerNames(List<String> listOwnerNames)
BrAPIListSearchRequest	listOwnerPersonDbIds(List<String> listOwnerPersonDbIds)
BrAPIListSearchRequest	listSources(List<String> listSources)
BrAPIListSearchRequest	listType(BrAPIListTypes listType)
BrAPIListSearchRequest	programDbIds(List<String> programDbIds)
BrAPIListSearchRequest	programNames(List<String> programNames)
void	setCommonCropNames(List<String> commonCropNames)
void	setDateCreatedRangeEnd(OffsetDateTime dateCreatedRangeEnd)
void	setDateCreatedRangeStart(OffsetDateTime dateCreatedRangeStart)
void	setDateModifiedRangeEnd(OffsetDateTime dateModifiedRangeEnd)
void	setDateModifiedRangeStart(OffsetDateTime dateModifiedRangeStart)
void	setExternalReferenceIds(List<String> externalReferenceIds)
void	setExternalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
void	setExternalReferenceSources(List<String> externalReferenceSources)
void	setListDbIds(List<String> listDbIds)
void	setListNames(List<String> listNames)
void	setListOwnerNames(List<String> listOwnerNames)
void	setListOwnerPersonDbIds(List<String> listOwnerPersonDbIds)
void	setListSources(List<String> listSources)
void	setListType(BrAPIListTypes listType)
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

BrAPIListSearchRequest

public BrAPIListSearchRequest()

Method Detail

commonCropNames

public BrAPIListSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

public BrAPIListSearchRequest 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 BrAPIListSearchRequest externalReferenceIds(List<String> externalReferenceIds)

addExternalReferenceIdsItem

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

Deprecated.

addExternalReferenceIDsItem

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

addExternalReferenceSourcesItem

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

dateCreatedRangeEnd

public BrAPIListSearchRequest dateCreatedRangeEnd(OffsetDateTime dateCreatedRangeEnd)

getDateCreatedRangeEnd

public OffsetDateTime getDateCreatedRangeEnd()

Get dateCreatedRangeEnd

Returns:

dateCreatedRangeEnd

setDateCreatedRangeEnd

public void setDateCreatedRangeEnd(OffsetDateTime dateCreatedRangeEnd)

dateCreatedRangeStart

public BrAPIListSearchRequest dateCreatedRangeStart(OffsetDateTime dateCreatedRangeStart)

getDateCreatedRangeStart

public OffsetDateTime getDateCreatedRangeStart()

Get dateCreatedRangeStart

Returns:

dateCreatedRangeStart

setDateCreatedRangeStart

public void setDateCreatedRangeStart(OffsetDateTime dateCreatedRangeStart)

dateModifiedRangeEnd

public BrAPIListSearchRequest dateModifiedRangeEnd(OffsetDateTime dateModifiedRangeEnd)

getDateModifiedRangeEnd

public OffsetDateTime getDateModifiedRangeEnd()

Get dateModifiedRangeEnd

Returns:

dateModifiedRangeEnd

setDateModifiedRangeEnd

public void setDateModifiedRangeEnd(OffsetDateTime dateModifiedRangeEnd)

dateModifiedRangeStart

public BrAPIListSearchRequest dateModifiedRangeStart(OffsetDateTime dateModifiedRangeStart)

getDateModifiedRangeStart

public OffsetDateTime getDateModifiedRangeStart()

Get dateModifiedRangeStart

Returns:

dateModifiedRangeStart

setDateModifiedRangeStart

public void setDateModifiedRangeStart(OffsetDateTime dateModifiedRangeStart)

listDbIds

public BrAPIListSearchRequest listDbIds(List<String> listDbIds)

addListDbIdsItem

public BrAPIListSearchRequest addListDbIdsItem(String listDbIdsItem)

getListDbIds

public List<String> getListDbIds()

Get listDbIds

Returns:

listDbIds

setListDbIds

public void setListDbIds(List<String> listDbIds)

listNames

public BrAPIListSearchRequest listNames(List<String> listNames)

addListNamesItem

public BrAPIListSearchRequest addListNamesItem(String listNamesItem)

getListNames

public List<String> getListNames()

Get listNames

Returns:

listNames

setListNames

public void setListNames(List<String> listNames)

listOwnerNames

public BrAPIListSearchRequest listOwnerNames(List<String> listOwnerNames)

addListOwnerNamesItem

public BrAPIListSearchRequest addListOwnerNamesItem(String listOwnerNamesItem)

getListOwnerNames

public List<String> getListOwnerNames()

Get listOwnerNames

Returns:

listOwnerNames

setListOwnerNames

public void setListOwnerNames(List<String> listOwnerNames)

listOwnerPersonDbIds

public BrAPIListSearchRequest listOwnerPersonDbIds(List<String> listOwnerPersonDbIds)

addListOwnerPersonDbIdsItem

public BrAPIListSearchRequest addListOwnerPersonDbIdsItem(String listOwnerPersonDbIdsItem)

getListOwnerPersonDbIds

public List<String> getListOwnerPersonDbIds()

Get listOwnerPersonDbIds

Returns:

listOwnerPersonDbIds

setListOwnerPersonDbIds

public void setListOwnerPersonDbIds(List<String> listOwnerPersonDbIds)

listSources

public BrAPIListSearchRequest listSources(List<String> listSources)

addListSourcesItem

public BrAPIListSearchRequest addListSourcesItem(String listSourcesItem)

getListSources

public List<String> getListSources()

Get listSources

Returns:

listSources

setListSources

public void setListSources(List<String> listSources)

listType

public BrAPIListSearchRequest listType(BrAPIListTypes listType)

getListType

public BrAPIListTypes getListType()

Get listType

Returns:

listType

setListType

public void setListType(BrAPIListTypes listType)

programDbIds

public BrAPIListSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

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

addProgramNamesItem

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