org.brapi.v2.model.core.request

Class BrAPITrialSearchRequest

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.core.request.BrAPITrialSearchRequest

public class BrAPITrialSearchRequest
extends BrAPISearchRequestParametersPaging

TrialSearchRequest

Constructor Summary

Constructors

Constructor and Description
BrAPITrialSearchRequest()

Method Summary

Modifier and Type	Method and Description
BrAPITrialSearchRequest	active(Boolean active)
BrAPITrialSearchRequest	addCommonCropNamesItem(String commonCropNamesItem)
BrAPITrialSearchRequest	addContactDbIdsItem(String contactDbIdsItem)
BrAPITrialSearchRequest	addExternalReferenceIdsItem(String externalReferenceIdsItem)
BrAPITrialSearchRequest	addExternalReferenceIDsItem(String externalReferenceIDsItem) Deprecated.
BrAPITrialSearchRequest	addExternalReferenceSourcesItem(String externalReferenceSourcesItem)
BrAPITrialSearchRequest	addLocationDbIdsItem(String locationDbIdsItem)
BrAPITrialSearchRequest	addLocationNamesItem(String locationNamesItem)
BrAPITrialSearchRequest	addProgramDbIdsItem(String programDbIdsItem)
BrAPITrialSearchRequest	addProgramNamesItem(String programNamesItem)
BrAPITrialSearchRequest	addStudyDbIdsItem(String studyDbIdsItem)
BrAPITrialSearchRequest	addStudyNamesItem(String studyNamesItem)
BrAPITrialSearchRequest	addTrialDbIdsItem(String trialDbIdsItem)
BrAPITrialSearchRequest	addTrialNamesItem(String trialNamesItem)
BrAPITrialSearchRequest	addTrialPUIsItem(String trialPUIsItem)
BrAPITrialSearchRequest	commonCropNames(List<String> commonCropNames)
BrAPITrialSearchRequest	contactDbIds(List<String> contactDbIds)
boolean	equals(Object o)
BrAPITrialSearchRequest	externalReferenceIds(List<String> externalReferenceIds)
BrAPITrialSearchRequest	externalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
BrAPITrialSearchRequest	externalReferenceSources(List<String> externalReferenceSources)
List<String>	getCommonCropNames() Common name for the crop which this program is for
List<String>	getContactDbIds() List of contact entities associated with this trial
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>	getLocationDbIds() The location ids to search for
List<String>	getLocationNames() A human readable names to search for
List<String>	getProgramDbIds() A program identifier to search for
List<String>	getProgramNames() A name of a program to search for
LocalDate	getSearchDateRangeEnd() The end of the overlapping search date range.
LocalDate	getSearchDateRangeStart() The start of the overlapping search date range.
BrAPISortBy	getSortBy()
BrAPISortOrder	getSortOrder()
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
List<String>	getTrialPUIs() A permanent identifier for a trial.
int	hashCode()
Boolean	isActive() Is this trail currently active
BrAPITrialSearchRequest	locationDbIds(List<String> locationDbIds)
BrAPITrialSearchRequest	locationNames(List<String> locationNames)
BrAPITrialSearchRequest	programDbIds(List<String> programDbIds)
BrAPITrialSearchRequest	programNames(List<String> programNames)
BrAPITrialSearchRequest	searchDateRangeEnd(LocalDate searchDateRangeEnd)
BrAPITrialSearchRequest	searchDateRangeStart(LocalDate searchDateRangeStart)
void	setActive(Boolean active)
void	setCommonCropNames(List<String> commonCropNames)
void	setContactDbIds(List<String> contactDbIds)
void	setExternalReferenceIds(List<String> externalReferenceIds)
void	setExternalReferenceIDs(List<String> externalReferenceIDs) Deprecated.
void	setExternalReferenceSources(List<String> externalReferenceSources)
void	setLocationDbIds(List<String> locationDbIds)
void	setLocationNames(List<String> locationNames)
void	setProgramDbIds(List<String> programDbIds)
void	setProgramNames(List<String> programNames)
void	setSearchDateRangeEnd(LocalDate searchDateRangeEnd)
void	setSearchDateRangeStart(LocalDate searchDateRangeStart)
void	setSortBy(BrAPISortBy sortBy)
void	setSortOrder(BrAPISortOrder sortOrder)
void	setStudyDbIds(List<String> studyDbIds)
void	setStudyNames(List<String> studyNames)
void	setTrialDbIds(List<String> trialDbIds)
void	setTrialNames(List<String> trialNames)
void	setTrialPUIs(List<String> trialPUIs)
BrAPITrialSearchRequest	studyDbIds(List<String> studyDbIds)
BrAPITrialSearchRequest	studyNames(List<String> studyNames)
String	toString()
BrAPITrialSearchRequest	trialDbIds(List<String> trialDbIds)
BrAPITrialSearchRequest	trialNames(List<String> trialNames)
BrAPITrialSearchRequest	trialPUIs(List<String> trialPUIs)

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

BrAPITrialSearchRequest

public BrAPITrialSearchRequest()

Method Detail

getSortBy

public BrAPISortBy getSortBy()

setSortBy

public void setSortBy(BrAPISortBy sortBy)

getSortOrder

public BrAPISortOrder getSortOrder()

setSortOrder

public void setSortOrder(BrAPISortOrder sortOrder)

commonCropNames

public BrAPITrialSearchRequest commonCropNames(List<String> commonCropNames)

addCommonCropNamesItem

public BrAPITrialSearchRequest addCommonCropNamesItem(String commonCropNamesItem)

getCommonCropNames

public List<String> getCommonCropNames()

Common name for the crop which this program is for

Returns:

commonCropNames

setCommonCropNames

public void setCommonCropNames(List<String> commonCropNames)

programDbIds

public BrAPITrialSearchRequest programDbIds(List<String> programDbIds)

addProgramDbIdsItem

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

addProgramNamesItem

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

addTrialDbIdsItem

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

addTrialNamesItem

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

addStudyDbIdsItem

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

addStudyNamesItem

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

locationDbIds

public BrAPITrialSearchRequest locationDbIds(List<String> locationDbIds)

addLocationDbIdsItem

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

addLocationNamesItem

public BrAPITrialSearchRequest addLocationNamesItem(String locationNamesItem)

getLocationNames

public List<String> getLocationNames()

A human readable names to search for

Returns:

locationNames

setLocationNames

public void setLocationNames(List<String> locationNames)

externalReferenceIds

public BrAPITrialSearchRequest externalReferenceIds(List<String> externalReferenceIds)

addExternalReferenceIdsItem

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

Deprecated.

addExternalReferenceIDsItem

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

addExternalReferenceSourcesItem

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

active

public BrAPITrialSearchRequest active(Boolean active)

isActive

public Boolean isActive()

Is this trail currently active

Returns:

active

setActive

public void setActive(Boolean active)

contactDbIds

public BrAPITrialSearchRequest contactDbIds(List<String> contactDbIds)

addContactDbIdsItem

public BrAPITrialSearchRequest addContactDbIdsItem(String contactDbIdsItem)

getContactDbIds

public List<String> getContactDbIds()

List of contact entities associated with this trial

Returns:

contactDbIds

setContactDbIds

public void setContactDbIds(List<String> contactDbIds)

searchDateRangeEnd

public BrAPITrialSearchRequest searchDateRangeEnd(LocalDate searchDateRangeEnd)

getSearchDateRangeEnd

public LocalDate getSearchDateRangeEnd()

The end of the overlapping search date range. `searchDateRangeStart` must be before `searchDateRangeEnd`. Return a Trial entity if any of the following cases are true - `searchDateRangeStart` is before `trial.endDate` AND `searchDateRangeEnd` is null - `searchDateRangeStart` is before `trial.endDate` AND `searchDateRangeEnd` is after `trial.startDate` - `searchDateRangeEnd` is after `trial.startDate` AND `searchDateRangeStart` is null - `searchDateRangeEnd` is after `trial.startDate` AND `searchDateRangeStart` is before `trial.endDate`

Returns:

searchDateRangeEnd

setSearchDateRangeEnd

public void setSearchDateRangeEnd(LocalDate searchDateRangeEnd)

searchDateRangeStart

public BrAPITrialSearchRequest searchDateRangeStart(LocalDate searchDateRangeStart)

getSearchDateRangeStart

public LocalDate getSearchDateRangeStart()

The start of the overlapping search date range. `searchDateRangeStart` must be before `searchDateRangeEnd`. Return a Trial entity if any of the following cases are true - `searchDateRangeStart` is before `trial.endDate` AND `searchDateRangeEnd` is null - `searchDateRangeStart` is before `trial.endDate` AND `searchDateRangeEnd` is after `trial.startDate` - `searchDateRangeEnd` is after `trial.startDate` AND `searchDateRangeStart` is null - `searchDateRangeEnd` is after `trial.startDate` AND `searchDateRangeStart` is before `trial.endDate`

Returns:

searchDateRangeStart

setSearchDateRangeStart

public void setSearchDateRangeStart(LocalDate searchDateRangeStart)

trialPUIs

public BrAPITrialSearchRequest trialPUIs(List<String> trialPUIs)

addTrialPUIsItem

public BrAPITrialSearchRequest addTrialPUIsItem(String trialPUIsItem)

getTrialPUIs

public List<String> getTrialPUIs()

A permanent identifier for a trial. Could be DOI or other URI formatted identifier.

Returns:

trialPUIs

setTrialPUIs

public void setTrialPUIs(List<String> trialPUIs)

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