org.brapi.v2.model.core

Class BrAPITrial

java.lang.Object

org.brapi.v2.model.core.BrAPITrial

public class BrAPITrial
extends Object

Trial

Constructor Summary

Constructors

Constructor and Description
BrAPITrial()

Method Summary

Modifier and Type	Method and Description
BrAPITrial	active(Boolean active)
BrAPITrial	addContactsItem(BrAPIContact contactsItem)
BrAPITrial	addDatasetAuthorshipsItem(BrAPITrialDatasetAuthorships datasetAuthorshipsItem)
BrAPITrial	additionalInfo(com.google.gson.JsonObject additionalInfo)
BrAPITrial	addPublicationsItem(BrAPITrialPublications publicationsItem)
BrAPITrial	commonCropName(String commonCropName)
BrAPITrial	contacts(List<BrAPIContact> contacts)
BrAPITrial	datasetAuthorships(List<BrAPITrialDatasetAuthorships> datasetAuthorships)
BrAPITrial	documentationURL(String documentationURL)
BrAPITrial	endDate(LocalDate endDate)
boolean	equals(Object o)
BrAPITrial	externalReferences(List<BrAPIExternalReference> externalReferences)
com.google.gson.JsonObject	getAdditionalInfo() Additional arbitrary info
String	getCommonCropName() Common name for the crop associated with this trial
@Valid List<BrAPIContact>	getContacts() List of contact entities associated with this trial
@Valid List<BrAPITrialDatasetAuthorships>	getDatasetAuthorships() License and citation information for the data in this trial
String	getDocumentationURL() A URL to the human readable documentation of this object
@Valid LocalDate	getEndDate() The date this trial ends
@Valid List<BrAPIExternalReference>	getExternalReferences() Get externalReferences
String	getProgramDbId() A program identifier to search for
String	getProgramName() Human readable name of the program
@Valid List<BrAPITrialPublications>	getPublications() MIAPPE V1.1 (DM-9) Associated publication - An identifier for a literature publication where the investigation is described.
@Valid LocalDate	getStartDate() The date this trial started
String	getTrialDbId() The ID which uniquely identifies a trial MIAPPE V1.1 (DM-2) Investigation unique ID - Identifier comprising the unique name of the institution/database hosting the submission of the investigation data, and the accession number of the investigation in that institution.
String	getTrialDescription() The human readable description of a trial MIAPPE V1.1 (DM-4) Investigation description - Human-readable text describing the investigation in more detail.
String	getTrialName() The human readable name of a trial MIAPPE V1.1 (DM-3) Investigation title - Human-readable string summarising the investigation.
String	getTrialPUI() A permanent identifier for a trial.
int	hashCode()
Boolean	isActive() Is this trail currently active
BrAPITrial	programDbId(String programDbId)
BrAPITrial	programName(String programName)
BrAPITrial	publications(List<BrAPITrialPublications> publications)
BrAPITrial	putAdditionalInfoItem(String key, Object additionalInfoItem)
void	setActive(Boolean active)
void	setAdditionalInfo(com.google.gson.JsonObject additionalInfo)
void	setCommonCropName(String commonCropName)
void	setContacts(List<BrAPIContact> contacts)
void	setDatasetAuthorships(List<BrAPITrialDatasetAuthorships> datasetAuthorships)
void	setDocumentationURL(String documentationURL)
void	setEndDate(LocalDate endDate)
void	setExternalReferences(List<BrAPIExternalReference> externalReferences)
void	setProgramDbId(String programDbId)
void	setProgramName(String programName)
void	setPublications(List<BrAPITrialPublications> publications)
void	setStartDate(LocalDate startDate)
void	setTrialDbId(String trialDbId)
void	setTrialDescription(String trialDescription)
void	setTrialName(String trialName)
void	setTrialPUI(String trialPUI)
BrAPITrial	startDate(LocalDate startDate)
String	toString()
BrAPITrial	trialDbId(String trialDbId)
BrAPITrial	trialDescription(String trialDescription)
BrAPITrial	trialName(String trialName)
BrAPITrial	trialPUI(String trialPUI)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BrAPITrial

public BrAPITrial()

Method Detail

getTrialDbId

public String getTrialDbId()

The ID which uniquely identifies a trial MIAPPE V1.1 (DM-2) Investigation unique ID - Identifier comprising the unique name of the institution/database hosting the submission of the investigation data, and the accession number of the investigation in that institution.

Returns:

trialDbId

setTrialDbId

public void setTrialDbId(String trialDbId)

trialDbId

public BrAPITrial trialDbId(String trialDbId)

active

public BrAPITrial active(Boolean active)

isActive

public Boolean isActive()

Is this trail currently active

Returns:

active

setActive

public void setActive(Boolean active)

additionalInfo

public BrAPITrial additionalInfo(com.google.gson.JsonObject additionalInfo)

putAdditionalInfoItem

public BrAPITrial putAdditionalInfoItem(String key,
                                        Object additionalInfoItem)

getAdditionalInfo

public com.google.gson.JsonObject getAdditionalInfo()

Additional arbitrary info

Returns:

additionalInfo

setAdditionalInfo

public void setAdditionalInfo(com.google.gson.JsonObject additionalInfo)

commonCropName

public BrAPITrial commonCropName(String commonCropName)

getCommonCropName

public String getCommonCropName()

Common name for the crop associated with this trial

Returns:

commonCropName

setCommonCropName

public void setCommonCropName(String commonCropName)

contacts

public BrAPITrial contacts(List<BrAPIContact> contacts)

addContactsItem

public BrAPITrial addContactsItem(BrAPIContact contactsItem)

getContacts

@Valid
public @Valid List<BrAPIContact> getContacts()

List of contact entities associated with this trial

Returns:

contacts

setContacts

public void setContacts(List<BrAPIContact> contacts)

datasetAuthorships

public BrAPITrial datasetAuthorships(List<BrAPITrialDatasetAuthorships> datasetAuthorships)

addDatasetAuthorshipsItem

public BrAPITrial addDatasetAuthorshipsItem(BrAPITrialDatasetAuthorships datasetAuthorshipsItem)

getDatasetAuthorships

@Valid
public @Valid List<BrAPITrialDatasetAuthorships> getDatasetAuthorships()

License and citation information for the data in this trial

Returns:

datasetAuthorships

setDatasetAuthorships

public void setDatasetAuthorships(List<BrAPITrialDatasetAuthorships> datasetAuthorships)

documentationURL

public BrAPITrial documentationURL(String documentationURL)

getDocumentationURL

public String getDocumentationURL()

A URL to the human readable documentation of this object

Returns:

documentationURL

setDocumentationURL

public void setDocumentationURL(String documentationURL)

endDate

public BrAPITrial endDate(LocalDate endDate)

getEndDate

@Valid
public @Valid LocalDate getEndDate()

The date this trial ends

Returns:

endDate

setEndDate

public void setEndDate(LocalDate endDate)

externalReferences

public BrAPITrial externalReferences(List<BrAPIExternalReference> externalReferences)

getExternalReferences

@Valid
public @Valid List<BrAPIExternalReference> getExternalReferences()

Get externalReferences

Returns:

externalReferences

setExternalReferences

public void setExternalReferences(List<BrAPIExternalReference> externalReferences)

programDbId

public BrAPITrial programDbId(String programDbId)

getProgramDbId

public String getProgramDbId()

A program identifier to search for

Returns:

programDbId

setProgramDbId

public void setProgramDbId(String programDbId)

programName

public BrAPITrial programName(String programName)

getProgramName

public String getProgramName()

Human readable name of the program

Returns:

programName

setProgramName

public void setProgramName(String programName)

publications

public BrAPITrial publications(List<BrAPITrialPublications> publications)

addPublicationsItem

public BrAPITrial addPublicationsItem(BrAPITrialPublications publicationsItem)

getPublications

@Valid
public @Valid List<BrAPITrialPublications> getPublications()

MIAPPE V1.1 (DM-9) Associated publication - An identifier for a literature publication where the investigation is described. Use of DOIs is recommended.

Returns:

publications

setPublications

public void setPublications(List<BrAPITrialPublications> publications)

startDate

public BrAPITrial startDate(LocalDate startDate)

getStartDate

@Valid
public @Valid LocalDate getStartDate()

The date this trial started

Returns:

startDate

setStartDate

public void setStartDate(LocalDate startDate)

trialDescription

public BrAPITrial trialDescription(String trialDescription)

getTrialDescription

public String getTrialDescription()

The human readable description of a trial MIAPPE V1.1 (DM-4) Investigation description - Human-readable text describing the investigation in more detail.

Returns:

trialDescription

setTrialDescription

public void setTrialDescription(String trialDescription)

trialName

public BrAPITrial trialName(String trialName)

getTrialName

public String getTrialName()

The human readable name of a trial MIAPPE V1.1 (DM-3) Investigation title - Human-readable string summarising the investigation.

Returns:

trialName

setTrialName

public void setTrialName(String trialName)

trialPUI

public BrAPITrial trialPUI(String trialPUI)

getTrialPUI

public String getTrialPUI()

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

Returns:

trialPUI

setTrialPUI

public void setTrialPUI(String trialPUI)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object