org.brapi.v2.model.core.request

Class BrAPIPersonSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.core.request.BrAPIPersonSearchRequest

public class BrAPIPersonSearchRequest
extends BrAPISearchRequestParametersPaging

BrAPIPersonSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPIPersonSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPIPersonSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPIPersonSearchRequest	addEmailAddressesItem(String emailAddressesItem)
BrAPIPersonSearchRequest	addExternalReferenceIdsItem(String externalReferenceIdsItem)
BrAPIPersonSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem) Deprecated.
BrAPIPersonSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPIPersonSearchRequest	addFirstNamesItem(String firstNamesItem)
BrAPIPersonSearchRequest	addLastNamesItem(String lastNamesItem)
BrAPIPersonSearchRequest	addMailingAddressesItem(String mailingAddressesItem)
BrAPIPersonSearchRequest	addMiddleNamesItem(String middleNamesItem)
BrAPIPersonSearchRequest	addPersonDbIdsItem(String personDbIdsItem)
BrAPIPersonSearchRequest	addPhoneNumbersItem(String phoneNumbersItem)
BrAPIPersonSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPIPersonSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPIPersonSearchRequest	addUserIDsItem(String userIDsItem)
BrAPIPersonSearchRequest	commonCropNames(List<String> commonCropNames)
BrAPIPersonSearchRequest	emailAddresses(List<String> emailAddresses)
boolean	equals(Object o)
BrAPIPersonSearchRequest	externalReferenceIds(List<String> externalReferenceIds)
BrAPIPersonSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
BrAPIPersonSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
BrAPIPersonSearchRequest	firstNames(List<String> firstNames)
List<String>	getCommonCropNames() The BrAPI Common Crop Name is the simple, generalized, widely accepted name of the organism being researched.
List<String>	getEmailAddresses() email address for this person
List<String>	getExternalReferenceIds() List of external reference IDs.
List<String>	getExternalReferenceIDs() Deprecated.
List<String>	getExternalReferenceSources() List of external references sources for the trait to search for
List<String>	getFirstNames() Persons first name
List<String>	getLastNames() Persons last name
List<String>	getMailingAddresses() physical address of this person
List<String>	getMiddleNames() Persons middle name
List<String>	getPersonDbIds() Unique ID for this person
List<String>	getPhoneNumbers() phone number of this person
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>	getUserIDs() A systems user ID associated with this person.
int	hashCode()
BrAPIPersonSearchRequest	lastNames(List<String> lastNames)
BrAPIPersonSearchRequest	mailingAddresses(List<String> mailingAddresses)
BrAPIPersonSearchRequest	middleNames(List<String> middleNames)
BrAPIPersonSearchRequest	personDbIds(List<String> personDbIds)
BrAPIPersonSearchRequest	phoneNumbers(List<String> phoneNumbers)
BrAPIPersonSearchRequest	programDbIds(List<String> programDbIds)
BrAPIPersonSearchRequest	programNames(List<String> programNames)
void	setCommonCropNames(List<String> commonCropNames)
void	setEmailAddresses(List<String> emailAddresses)
void	setExternalReferenceIds(List<String> externalReferenceIds)
void	setExternalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
void	setExternalReferenceSources(List<String> externalReferenceSources)
void	setFirstNames(List<String> firstNames)
void	setLastNames(List<String> lastNames)
void	setMailingAddresses(List<String> mailingAddresses)
void	setMiddleNames(List<String> middleNames)
void	setPersonDbIds(List<String> personDbIds)
void	setPhoneNumbers(List<String> phoneNumbers)
void	setProgramDbIds(List<String> programDbIds)
void	setProgramNames(List<String> programNames)
void	setUserIDs(List<String> userIDs)
String	toString()
BrAPIPersonSearchRequest	userIDs(List<String> userIDs)

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

BrAPIPersonSearchRequest

public BrAPIPersonSearchRequest()

Method Detail

commonCropNames

public BrAPIPersonSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

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

addExternalReferenceIdsItem

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

externalReferenceIDs

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

Deprecated.

addExternalReferenceIDsItem

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

addExternalReferenceSourcesItem

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

emailAddresses

public BrAPIPersonSearchRequest emailAddresses(List<String> emailAddresses)

addEmailAddressesItem

public BrAPIPersonSearchRequest addEmailAddressesItem(String emailAddressesItem)

getEmailAddresses

public List<String> getEmailAddresses()

email address for this person

Returns:

emailAddresses

setEmailAddresses

public void setEmailAddresses(List<String> emailAddresses)

firstNames

public BrAPIPersonSearchRequest firstNames(List<String> firstNames)

addFirstNamesItem

public BrAPIPersonSearchRequest addFirstNamesItem(String firstNamesItem)

getFirstNames

public List<String> getFirstNames()

Persons first name

Returns:

firstNames

setFirstNames

public void setFirstNames(List<String> firstNames)

lastNames

public BrAPIPersonSearchRequest lastNames(List<String> lastNames)

addLastNamesItem

public BrAPIPersonSearchRequest addLastNamesItem(String lastNamesItem)

getLastNames

public List<String> getLastNames()

Persons last name

Returns:

lastNames

setLastNames

public void setLastNames(List<String> lastNames)

mailingAddresses

public BrAPIPersonSearchRequest mailingAddresses(List<String> mailingAddresses)

addMailingAddressesItem

public BrAPIPersonSearchRequest addMailingAddressesItem(String mailingAddressesItem)

getMailingAddresses

public List<String> getMailingAddresses()

physical address of this person

Returns:

mailingAddresses

setMailingAddresses

public void setMailingAddresses(List<String> mailingAddresses)

middleNames

public BrAPIPersonSearchRequest middleNames(List<String> middleNames)

addMiddleNamesItem

public BrAPIPersonSearchRequest addMiddleNamesItem(String middleNamesItem)

getMiddleNames

public List<String> getMiddleNames()

Persons middle name

Returns:

middleNames

setMiddleNames

public void setMiddleNames(List<String> middleNames)

personDbIds

public BrAPIPersonSearchRequest personDbIds(List<String> personDbIds)

addPersonDbIdsItem

public BrAPIPersonSearchRequest addPersonDbIdsItem(String personDbIdsItem)

getPersonDbIds

public List<String> getPersonDbIds()

Unique ID for this person

Returns:

personDbIds

setPersonDbIds

public void setPersonDbIds(List<String> personDbIds)

phoneNumbers

public BrAPIPersonSearchRequest phoneNumbers(List<String> phoneNumbers)

addPhoneNumbersItem

public BrAPIPersonSearchRequest addPhoneNumbersItem(String phoneNumbersItem)

getPhoneNumbers

public List<String> getPhoneNumbers()

phone number of this person

Returns:

phoneNumbers

setPhoneNumbers

public void setPhoneNumbers(List<String> phoneNumbers)

programDbIds

public BrAPIPersonSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

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

addProgramNamesItem

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

userIDs

public BrAPIPersonSearchRequest userIDs(List<String> userIDs)

addUserIDsItem

public BrAPIPersonSearchRequest addUserIDsItem(String userIDsItem)

getUserIDs

public List<String> getUserIDs()

A systems user ID associated with this person. Different from personDbId because you could have a person who is not a user of the system.

Returns:

userIDs

setUserIDs

public void setUserIDs(List<String> userIDs)

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